Export (0) Print
Expand All

Required Elements By Object

Atlas API
System_CLiX_note Note

Atlas is now part of Facebook. To access Atlas API documentation, please click here.

The Reporting API enables you to submit requests for reports that contain impression exchange, internal publisher, or web media data. This topic contains reference information about how to construct a report request for each report type.

SubmitReport Service Operation

To submit a request for an impression exchange, internal publisher, or web media report, use the SubmitReport service operation. It receives a ReportSubmission request message object from the client that contains the parameters to use to generate the report.

ReportSubmission Request Message Object

The ReportSubmission request message object is used with the SubmitReport service operation to specify the report parameters. In addition to a UserCredentials object and a DeveloperToken string, the ReportSubmission request object requires a ReportRequest object that specifies the parameters to use to generate the requested report.

ReportRequest Data Object

The following table lists the report request object, report columns, filter columns, and code sample for each report type.

Report Type

ReportRequest Object

Report Columns

Report Filter Object

Report Filter Columns

Required Filter Column Value

Code Sample

Impression Exchange (External Publisher)

ImpressionExchangeReportRequest

This report type is available to only the following Atlas Media Console user types:

  • Publisher administrators

  • Publisher users

  • Agency administrators

ImpressionExchangeReportColumn

ImpressionExchangeFilter

ImpressionExchangeReportFilter

ClientGUID for all users.

PublisherGUID for publisher administrators and users only.

How to Request an Impression Exchange Report in C#

Internal Publisher

PublisherReportRequest

This report type is available for only the following Atlas Media Console user types:

  • Agency administrators

  • Agency users

PublisherReportColumn

PublisherFilter

PublisherReportFilter

ProgramGUID

How to Request an Internal Publisher Report in C#

Paid Search

PaidSearchReportRequest

This report type is available for only the following Atlas Media Console user types:

  • Agency administrators

  • Agency users

PaidSearchReportColumn

PaidSearchFilter

PaidSearchReportFilter

ClientGUID

How to Request a Paid Search Report in C#

Web Media

WebMediaReportRequest

This report type is available for only the following Atlas Media Console user types:

  • Agency administrators

  • Agency users

WebMediaReportColumn

WebMediaFilter

WebMediaReportFilter

ClientGUID

How to Request a Web Media Report:

DateFilter Data Object

In addition to filtering report data by column, each report request must also specify a date filter. Report data can be filtered by using a specified start date and end date, or by using a relative date range. For information about how to set up the date filter, see DateFilter.

See Also

Concepts

API Reference

Show:
© 2015 Microsoft