get

/{report}/validate

Validating Data Retrieval Requests

Data retrieval requests can be validated and authenticated without actually requesting data, by simply appending a /validate path segment to the URI. Important: The validation process takes into account the current user’s permissions. The error responses that are returned in case of validation failure are the same as the ones that would have been returned by the regular API call.

The following shows an example validation request for a request with an erroneous organization_id filtering parameter:

GET /reporting/v1/std/{report}/validate?filter=organization_id%3D12345&dimensions=campaign_id%2Corganization_id&time_window=last_7_days&time_rollup=by_day
HTTP/1.0 404 Not Found
Content-Type: text/xml; charset=UTF-8

<?xml version='1.0' ?>
<result>
  <entity id="12345" type="organization" />
  <status code="not_found">Entity Not Found</status>
</result>

By contrast, this call shows a validation response for a valid call:

GET /reporting/v1/std/{report}/validate?filter=organization_id%3D12346&dimensions=campaign_id%2Corganization_id&time_window=last_7_days&time_rollup=by_day
HTTP/1.0 200 OK
Content-Type: text/xml; charset=UTF-8

<?xml version='1.0' ?>
<result>
  <status code="ok" />
</result>

Request Parameters

1 Path Parameter
12 Query Parameters
3 Headers

Responses

The 200 response.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
report
$$.env
No $$.env variables are being used in this request.