GuidesAPI ReferenceChangelog
API Reference
Select productLog inHelp centre

Campaigns summary report

get
https://{region}-api-freshrelevance.dotdigital.com/api//campaigns/

Retrieves a summary report of campaings executed in the given time range for the requesting account and website. Note the system uses next day attribution to collate this data.

📘

The system uses next day attribution to collate this data.

Path Params
string
required

Website ID for the account you are posting data to.

Query Params
string
enum
Defaults to json

Get data in this format.

Allowed:
integer
≥ 1
Defaults to 25

Get this number of records to return in results array (pagination).

integer
Defaults to 1

Which page of results you wish to return; First page is indexed as 1.

date-time

Start date for reporting data in ISO-8601 format, defaults to previous day.

date-time

End date for reporting data in ISO-8601 format, defaults to today.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden - Usually you are requesting data for a website you don't have access to.

Updated about 1 month ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/csv

Updated about 1 month ago

Did this page help you?