Support

API Reference

📘

Click here to view API documentation concerning the /reportsendpoint

The /data endpoint allows you to find and retrieve Attribution report metrics for one or more reports.

If you request data for a single report, the result will be returned to you synchronously. If you request data for multiple reports, the result will be made available at our /data/{requestId} endpoint. These results will be available for 30 days. More information about these workflows can be found in Examples & Templates.

Formatted Responses

The default responses are provided in JSON format. For a CSV formatted response, add ".csv" to the URL:

JSON (default):

CSV:

/data Endpoint

EndpointVerbBodyAccepts
/dataPOSTRequestJSON

Request

keytypedescription
reportIdsArrayArray of Placement or Custom Report IDs. If a single reportId is specified, the result will be returned synchronously. If multiple reportIds are specified, the result will be returned asynchronously.
metricsArrayArray of metric
dimensionsArrayArray of dimensions
filtersArrayArray of filter Currently one filter is supported at a time. A filter may have more than one Predicate
optionsObjectrequestOptions

Metric

keytypedescription
nameStringAvailable Metrics

Dimension

keytypedescription
nameStringAvailable Dimensions

Filter

keytypedescription
predicatesArrayArray of Predicate. The data returned by this request will satisfy all of the given Predicates.

Predicate

keytypedescription
dimensionObjectDimensions
operatorObjectOperator
valuesArrayArray of values to be used by the operator function.

Operator

keytypedescription
nameStringIN, NOT_IN, BETWEEN, LIKE, GREATER_THAN, LESS_THAN

RequestOptions

keytypedescription
includeQueryInResponseBooleanSet to true if you would like your request/query included in your response.

Response

keytypedescription
resultObjectResult A Result is returned if the request is complete. (This object has the same structure as the Result returned from the /data endpoint)
statusObjectStatus

Result

keytypedescription
dataObjectData
queryObjectRequest Included if original request's includeQueryInRepsonse option is set to true

Data

keytypedescription
columnsArrayArray of Column
rowsArrayArray of Row

Column

keytypedescription
nameStringReport ID, Dimension or Metric Name
typeStringREPORT_ID, DIMENSION, METRIC

Row

keytypedescription
valuesArrayValues corresponding, in order, to the Data columns
overviewBooleanRepresents whether or not the row is a summary or rollup of the other rows

Status

keytypedescription
requestIdStringMulti-report request ID. This ID can be used to access the multi-report request status and result which is available at the /data/{requestId} endpoint
resultUrlBooleanURL at which the multi-report request status and result are made available
stateStringState of the request, should be set to "PENDING" for all pending requests
queryObjectRequest. The original report query will be included if the includeQueryInResponse key is included in the request's request options

/data/{requestId} Endpoint

This endpoint is used when accessing data from multi-report queries.

EndpointVerbBodyAccepts
/data/{requestId}GET or POSTRequest. Request is optional and can be included in a POST requestJSON

Request

keytypedescription
optionsObjectrequestOptions

Response

keytypedescription
resultObjectResult. A Result is returned if the request is complete. (This object has the same structure as the Result returned from the /data endpoint)
statusObjectStatus. A Status is returned if the request is incomplete. (This object has the shape as the Status returned from the /data endpoint, but only includes the status and optional query keys)