# Retrieve API tracking logs

Retrieves API tracking log records.

Endpoint: GET /tracking/api
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each 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.

  - `expand` (string)
    Expands a request to include embedded objects within the 
property of the response. This field accepts a comma-separated list of objects.

For more information, see
Expand to include embedded objects.

## Response 200 fields (application/json):

  - `id` (string)
    Unique resource ID.
    Example: "4f6cf35x-2c4y-483z-a0a9-158621f77a21"

  - `status` (integer)
    Response code of the HTTP request.

  - `url` (string)
    URL of the HTTP request.

  - `route` (string)
    API request route.
    Example: "/customers/{param}"

  - `method` (string)
    HTTP method of the API request.
    Enum: "HEAD", "GET", "POST", "PUT", "DELETE", "PATCH"

  - `request` (string)
    Request body of the HTTP request.

  - `response` (string)
    Response body of the HTTP request.

  - `requestHeaders` (object)
    HTTP headers.
    Example: {"Content-Type":"application/json","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"}

  - `responseHeaders` (object)
    HTTP headers.
    Example: {"Content-Type":"application/json","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"}

  - `user` (object)
    User who made the request.

  - `user.userId` (string)
    ID of the user.
    Example: "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"

  - `user.apiKeyId` (string)
    ID of the API tracking log.
    Example: "api_key_0YV7JQMY6ED2FBE58BMFHBWBZH"

  - `user.email` (string)
    Email address of the user.

  - `user.firstName` (string)
    First name of the user.

  - `user.lastName` (string)
    Last name of the user.

  - `user.userAgent` (string)
    Software that is acting on behalf of the user.

  - `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.

  - `user.isSupport` (boolean)
    Specifies if the API request is completed by a Rebilly Support Team member.

  - `user.ipAddress` (string)
    Client IP address.

  - `relatedResourceIds` (array)
    IDs of related resources.
    Example: ["in_0YVF9605RKC62BP14NE2R7V2XT","cus_0YV7DDSDD1C8DA64KHH2W33CPF"]

  - `duration` (integer)
    Request duration in milliseconds.

  - `organizationId` (string)
    Unique organization identifier.
An organization is an entity that represents a company.
For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "org_0YVDM8RC7GDADADSBSMW124JA8"

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self"

  - `_embedded` (object)
    Embedded objects that are requested by the  query parameter.

  - `_embedded.organization` (object)

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.