Skip to end of metadata
Go to start of metadata

Saved Report Service

The Saved Report service can be used to create new reports which are saved and can be retrieved at any time. They are useful for reports which are executed frequently. The Saved Report Service acts as a wrapper around the Report Service.

There is a limit of 100K rows per report.

A few facts to keep in mind about saved reports:

  • Saved reports expire after 6 months. You must create a new saved report after 6 months.
  • Saved reports cannot have a Lifetime or Custom date range.
  • Saved reports are run in the order in which they were originally created. For example, if you create two daily reports, the daily report created first will run first each day. 
  • Daily reports are run and sent each day at varying times throughout the day.
  • Weekly reports are run and sent on the Monday of each week for the previous 7 days.
  • Monthly reports are run and sent on the first day of each month.
On This Page

REST API

Reports saved by other users within your network (member) will not be returned in these calls. Only those reports saved by your user account will be returned.


To view all saved reports for an advertiser or publisher:

To view a specific saved report:

To add a new saved report for an advertiser or publisher:

To modify an existing saved report for an advertiser or publisher:

To delete an existing saved report:

JSON Fields

Field

Type

Description

Required On

id

int

The internal ID associated with the saved report.

PUT, in querystring

name

string

The name of the report which is display in the UI. The maximum length is 100 characters.

 

report

object

Report defined in the same format as used in the Reporting Service.

 

scheduling

enum

The frequency with which the report is executed. Possible values: "daily", "weekly", or "monthly".

 

format

enum

The format in which the report results will be saved. Possible values: "excel" or "csv".

 

emails

array

The list of emails to send the report. The array should be in the format ["email_address1@domain.com", "email_address2@domain.com", ...]

 

expires_on

string

The date and time on which a saved report expires. This is currently limited to one year in the future. The date/time should be specified in the format "YYYY-MM-DD HH:MM:SS" where the time is specified in 24-hour format.

POST, PUT

created_on

string

The date and time on which the saved report was created.

 

entity_id

int

The entity ID of the user creating the report. This sets the scope of the report.

 

category

string

The category of the report.

 

last_modified

string

The date and time on which the saved report was last modified.

 

Examples

Adding a new saved report for a publisher:

  1. Construct a report JSON (as described in Report Service - Step1)
  2. POST the JSON to the saved-report service
  3. Store the id that is returned

Executing and retrieving a saved report (you must perform this step every time you wish to retrieve an updated report):

  1. POST to the report service with the id from above, and store the returned report_id
  2. Check the report's status with a GET to the report service with the report_id (as described in Report Service - Step3)
  3. GET the report from the report-download service (as described in Report Service - Step4)