API Usage Constraints
Input and Output Throttling
To ensure good performance, all accounts are limited. We categorize these rate limits into read and write requests. Currently, the default read and write limit is 1000 per minute. This limit is enforced programmatically by the API on a member level. That means if there are two API users for a single member, they will share the throttling limit (i.e., two users can average 500 reads per minute each, four users can average 25 reads per minute each). If you require more reads or writes per minute, please reach out to your Xandr account representative.
If you exceed the throttling limit, the API will respond with the HTTP 429 (Too Many Requests) response code along with an error message in the response contents. An example of the error message is shown here:
If you're using a script, you should check for the 429 response code. If you receive this code, sleep your script for the number returned in the
Retry-After field of the response header. This field tells you how long before your throttle limit is reset and you can continue processing API commands.
In addition to the response code and response header, every response from the API will contain a
dbg_info parameter. This parameter contains information about the API call and response. Below is an example of this debug output, which includes any warnings received from the API, the API version used for the call that generated this response, and the service used.
The maximum number of objects that can be returned in a given GET response is 100. To retrieve more than 100 objects, you can paginate results by specifying
num_elements in the query string of the GET request. For example, the following request would return the first 50 objects in the response:
To retrieve the next 50, you would simply set
- The first element is element 0.
- All GET responses will have a "count" property showing the total number of elements matching that GET request.
- This will also apply to non-reporting services, such as the creative search service, that are requested with methods other than GETs.
After authenticating, your token remains valid for 2 hours. You do not need to re-authenticate within this time. If you do re-authenticate, please note the following limitation: The API permits you to authenticate successfully 10 times per 5-minute period. Any subsequent authentication attempts within those 5 minutes will result in an error.
It is best practice to listen for the "NOAUTH" error_id in your call responses and re-authenticate only after receiving it.
Xandr limits the number of line items, campaigns, creatives, publishers, sites, and placements that you can have on the platform. In addition, Xandr limits the number of domains that can be used in a single domain list and the number of certain targets that can be used in a single profile. You can use the Object Limit Service to view your limits and proactively monitor your usage.
For all object types except creatives, both active and inactive objects are counted against the limit. For creatives, only non-expired objects are counted against the limit. A creative expires when it has neither served nor been modified in 45 days.
For most clients, the default object limits are as follows:
Creatives per member
Campaigns per member
Line items per member
Placements per member
Sites per member
Publishers per member
Domains per domain list
Segments targeted per profile
Segment groups targeted per profile
Content categories targeted per profile
Platform content categories targeted per profile
Postal codes targeted per profile
Inventory sources targeted per profile
Publishers targeted per profile
Placement Groups targeted per profile
Placements targeted per profile
|Deals targeted per member (note: only deals with profiles are counted against this limit)||1000|
|Profiles targeted per member||100|
How will I know that I am approaching my limit for an object?
We send you an email notification when you reach 85% and 95% of your limit for an object and another email when you reach 100% of your limit.
Who receives object limit email notifications?
Object limit notification emails are sent to the email addresses specified in the
sherlock_notify_email field of the Member Service. You can change the recipients at any time. Note, however, that this field controls the recipients for creative auditing emails as well.
What if I reach my limit for an object?
When you approach or reach your limit for campaigns, line items, placements, sites, or publishers, you should delete any inactive, unused, or unnecessary instances so you can stay under your limit. You can use the Advertiser Cleanup tool to bulk-delete objects (customer login required). Deleted line items, campaigns, creatives, publishers, sites, and placements will continue to appear in reporting but cannot be undeleted.
When you approach or reach your limit for creatives, you should remove non-expired creatives. Non-expired creatives have the
is_expired field set to
false. Note that removing expired creatives will not impact your creative count.
What if I am already over my limit?
If you need to create additional objects but have already met or exceeded your limit as listed above, please delete unused objects or contact support for assistance. Our support team can help you identify inactive objects to delete.
Can my limit be raised?
In exceptional cases, a limit may be temporarily lifted by a small amount at the discretion of our engineering team. Please contact your Xandr representative to discuss this option.