Retrieve a tracking API log

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

Tracking API log retrieved.

Response Schema: application/json
id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
integer

HTTP response code.

url
string

API request address.

route
string

API request route.

method
string

HTTP method.

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 has made a 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>

User email.

firstName
string

User first name.

lastName
string

User last name.

ipAddress
string <ipv4>
Deprecated

Client IP address.

userAgent
string

Software that is acting on behalf of a user.

fingerprint
string

User device fingerprint hash.

isSupport
boolean

If user from support.

ipAddress
string

Client IP address.

object

IDs of related resources.

customerId
string (CustomerId) <= 50 characters

Customer resource ID. Defaults to UUID v4.

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.

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 (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
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": {
    },
  • "responseHeaders": {
    },
  • "user": {
    },
  • "ipAddress": "string",
  • "relatedIds": {
    },
  • "duration": 0,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}