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.

On This Page

REST API

To view all saved reports for your member:
GET http://api.adnxs.com/saved-report 

To view a specific saved report:
GET http://api.adnxs.com/saved-report/ID 

To add a new saved report:
POST http://api.adnxs.com/saved-report

To modify an existing saved report:
PUT http://api.adnxs.com/saved-report/ID

To delete an existing saved report:
DELETE http://api.adnxs.com/saved-report/ID 

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 Report 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

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_activity

string

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

 

Examples

Adding a new saved report for a publisher

Executing and retrieving a saved report

Updating an Existing Report

Related Topics