Check Usage Statistics
This field or feature is part of functionality currently in either Alpha or Beta phase. It is therefore subject to change.
REST API call
When making a call to the API to retrieve statistics, the following fields can be set in the query string:
aggcan be omitted in order to obtain an hourly/detailed report
agg=truecan be used to obtain an aggregated report
startdate should be set in the following format:
enddate should be set in the following format:
The statistics are deduplicated per request made to the service. For example, if the same user is added to the same segment in three different requests,
num_valid_users would show "3". When using
agg=true, there will be one entry in the report property of the response. It will be an aggregation of all usage statistics in the date range that's specified.
segment_log_lines will be empty, and the processed hour will be for the last hour in the date range that's specified. However, if no date range is specified, the report will show the data from the last two weeks.
Report object JSON (for objects in report array):
|Field name||Description||Example value|
|Hour during which uploads went through.|
|The percentage of valid users uploaded (num_valid_users/(num_valid_users+num_invalid_users))||75.00|
|Total number of valid users that were streamed through the service. This is NOT the number of unique users for the hour.||124578|
Total number of associations that were added (that is, user-segment pairs, expiration !=-1)
|Total number of associations that were removed (that is, user-segment pairs with expiration = -1)||98765432|
Total number of users that were in requests, but do not exist on Xandr's platform.
|Total number of associations that failed due to attempting to access unauthorized segments.||500|
|Total number of associations that failed due to attempting to access inactive segments.||200|
|Total number of associations that failed due to attempting to access invalid segments.||3|
|Total number of failed calls for other reasons.||0|
An updating 200 line sample of the errors that prevented the user and segment associations from being successful.
An updating 200 line sample of the segments and the number of valid associations for each.