Rebilly API Docs

Retrieve an API tracking log

Retrieves an API tracking log record with a specified ID.

SecuritySecretApiKey or JWT

Request

path Parameters

required

string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses

200

Tracking API log retrieved.

Response Schema: application/json

string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status

integer

HTTP response code.

url

string

Address of the API request.

route

string

API request route.

method

string

HTTP method of the API request.

Enum: "HEAD" "GET" "POST" "PUT" "DELETE" "PATCH"

request

string

Request JSON-string.

response

string

Response JSON-string.

object (HttpHeaders)

HTTP headers.

property name*

additional property

string

object (HttpHeaders)

HTTP headers.

property name*

additional property

string

object

User who made the request.

userId	string <= 50 characters Unique resource ID. Defaults to UUID v4.
apiKeyId	string <= 50 characters Unique resource ID. Defaults to UUID v4.
email	string <email> Email address of the user.
firstName	string First name of the user.
lastName	string Last name of the user.
ipAddress	string <ipv4> Deprecated Client IP address.
userAgent	string Software that is acting on behalf of the user.
fingerprint	string User's device fingerprint hash. A device fingerprint is a unique token that is used to identify the user. The device fingerprint is generated based on device attributes, such as: hardware, software, IP address, language, browser, and more.
isSupport	boolean Specifies if the API request is completed by a Rebilly Support Team member.

ipAddress

string

Client IP address.

object

IDs of related resources.

customerId	string (CustomerId) <= 50 characters ID of the customer resource.
transactionId	string (ResourceId) <= 50 characters Unique resource ID. Defaults to UUID v4.
tokenId	string (ResourceId) <= 50 characters Unique resource ID. Defaults to UUID v4.

duration

integer

Request duration in milliseconds.

organizationId

string (OrganizationId) <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

createdTime

string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime

string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array

href	string Link URL.
rel	string Type of link. Value: "self"

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/tracking/api/{id}

Request samples

$apiTrackingLog = $client->apiTracking()->load('apiLogId');

Response samples

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"status": 0,
"url": "string",
"route": "/customers/{param}",
"method": "HEAD",
"request": "string",
"response": "string",
"requestHeaders": {"Content-Type": "application/json",
"Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
},
"responseHeaders": {"Content-Type": "application/json",
"Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
},
"user": {"userId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"apiKeyId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"email": "user@example.com",
"firstName": "string",
"lastName": "string",
"ipAddress": "192.168.0.1",
"userAgent": "string",
"fingerprint": "string",
"isSupport": true
},
"ipAddress": "string",
"relatedIds": {"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"transactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"tokenId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"duration": 0,
"organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"_links": [{"href": "string",
"rel": "self"
}
]
}

➔ Next to Retrieve value list changes