Retrieve tracking API logs

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

header Parameters
Accept
string
Default: application/json

Response media type.

Enum: "application/json" "text/csv"
Responses
200

Tracking API logs retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
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.

get/tracking/api
Request samples
$apiTrackingLog = $client->apiTracking()->search([
    'filter' => 'status:200',
]);
Response samples
application/json
[
  • {
    }
]