Tracking

Use tracking when debugging and auditing issues. Tracking is a layer for accessing all activity such as: API requests, subscriptions, webhooks, events, and more.
Operations

Retrieve API tracking logs

Request

Retrieves API tracking log records.
Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

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

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Embedded resources.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/tracking/api?limit=0&offset=0&sort=string&filter=string&q=string&expand=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Tracking API logs retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 characters(ResourceId)
Unique resource ID.
Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
statusinteger
Response code of the HTTP request.
urlstring
URL of the HTTP request.
routestring
API request route.
Example:"/customers/{param}"
methodstring
HTTP method of the API request.
Enum:"HEAD""GET""POST""PUT""DELETE""PATCH"
requeststring
Request body of the HTTP request.
responsestring
Response body of the HTTP request.
requestHeadersobject(HttpHeaders)
HTTP headers.
Example:
{
  "Content-Type": "application/json",
  "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}
responseHeadersobject(HttpHeaders)
HTTP headers.
Example:
{
  "Content-Type": "application/json",
  "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}
userobjectread-only
User who made the request.
authenticationMethodstring or nullread-only

Authentication method of the API request. This value is null if the request is unauthenticated.

Enum ValueDescription
secret-api-key
Secret API key.
signature

Request signed with a secret API key in the REB-AUTH header.

jwt-user

JSON Web Token (JWT) of a user.

jwt-customer
JWT of a customer.
publishable-key
Publishable API key.
jwt-guest
JWT of a guest session.
jwt-application
JWT of an application instance.
jwt-service-account
JWT of a service account.
null
Unauthenticated request.
ipAddressstring
Client IP address.
relatedResourceIdsArray of stringsread-only
IDs of related resources.
Example:
[
  "in_0YVF9605RKC62BP14NE2R7V2XT",
  "cus_0YV7DDSDD1C8DA64KHH2W33CPF"
]
durationinteger
Request duration in milliseconds.
organizationIdstring, <= 50 characters(OrganizationId)

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

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
_linksArray of objects(SelfLink)read-only
Related links.
_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
[
  {
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "status": 0,
    "url": "string",
    "route": "/customers/{param}",
    "method": "HEAD",
    "request": "string",
    "response": "string",
    "requestHeaders": { … },
    "responseHeaders": { … },
    "user": { … },
    "authenticationMethod": "secret-api-key",
    "ipAddress": "string",
    "relatedResourceIds": [ … ],
    "duration": 0,
    "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ],
    "_embedded": { … }
  }
]