API Reference

📘

Click here to view API documentation concerning the /data endpoint

The /reports endpoint allows you to find and retrieve attribution report IDs and associated metadata.

Formatted Responses

Format

The default responses for these endpoints are delivered in JSON format. To request a CSV formatted response, simply append the format to the URL as shown:

Pagination

The response from the /reports endpoint is paginated, returning the first page of results with 50 rows per page by default. The result page can be changed using the page key, and the result count per page can be increased to up to 100 rows using the perPage key. Both keys are described in the Request table below.


Endpoint

EndpointVerbBodyAccepts
/reportsPOSTRequestJSON

Request

keytypedescription
filtersArrayArray of filter
pageIntegerReports page index, default = 1
perPageIntegerMax number of reports per page, default = 50
optionsObjectrequestOptions

Filter

keytypedescription
predicatesArrayArray of Predicate

Predicate

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

Dimension

keytypedescription
nameStringname, type, status, startDate, endDate, campaign, advertiser, partner

Operator

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

Request Options

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

Response

keytypedescription
reportsArrayArray of report
pageIntegerPage index.
perPageIntegerMax number of reports per page, default = 50
totalPagesIntegerNumber of pages of results that are available
queryObjectRequest. Included if original request's includeQueryInRepsonse option is set to "true"

Report

keytypedescription
idString
nameString
typeStringOVERALL, PARTNER, CUSTOM
statusStringCOMPLETED, PENDING, PROCESSING
startDateStringFormatted Date, YYY-MM-DD
endDateStringFormatted Date, YYY-MM-DD
lastUpdateDateStringFormatted Date, YYY-MM-DD
campaignObjectCampaign
advertiserObjectAvertiser
partnerObjectPartner

Campaign

keytypedescription
nameString

Advertiser

keytypedescription
nameString

Partner

keytypedescription
nameString