Tracking

Tracking is a layer for accessing all the activity (API requests, subscriptions, webhooks, events, etc.), thus providing easier debugging and issues auditing.

Retrieve a list of tracking API logs

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Accept
string
Default: application/json

The response media type.

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

Tracking API logs was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

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

Retrieve a tracking API log with specified identifier string

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Tracking API log was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was 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",
  • "_links": [
    ]
}

Retrieve Lists changes history

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Lists changes history was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/tracking/lists
Request samples
// all parameters are optional
const firstCollection = await api.tracking.getAllListsChangesHistory();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100}; 
const secondCollection = await api.tracking.getAllListsChangesHistory(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(entry => console.log(entry.fields.name));
Response samples
application/json
[
  • {
    }
]

Retrieve a list of tracking webhook notifications

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Tracking webhook notifications were retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/tracking/webhooks
Request samples
// all parameters are optional
const firstCollection = await api.tracking.getAllWebhookTrackingLogs();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100}; 
const secondCollection = await api.tracking.getAllWebhookTrackingLogs(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(entry => console.log(entry.fields.eventType));
Response samples
application/json
[
  • {
    }
]

Retrieve a tracking webhook notification with specified identifier string

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Tracking webhook notification was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/tracking/webhooks/{id}
Request samples
const entry = await api.tracking.getWebhookTrackingLog({id: 'foobar-001'});
console.log(entry.fields.eventType);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "eventType": "account-password-reset-requested",
  • "entityId": "string",
  • "url": "string",
  • "method": "POST",
  • "headers": {
    },
  • "responseCode": 0,
  • "responseBody": "string",
  • "payload": "string",
  • "source": "webhooks",
  • "attempt": 0,
  • "sentTime": "2019-08-24T14:15:22Z",
  • "initiatedTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Schedules webhook resend attempt for specified webhook tracking.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Webhook resend attempt was scheduled.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

post/tracking/webhooks/{id}/resend
Request samples
curl -i -X POST \
  https://api-sandbox.rebilly.com/organizations/unknown/tracking/webhooks/:id/resend \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}