API Reference

The report object

The report object holds general information information about a report as well as the Uri needed to run the report. You can only list all reports.

Attributes

Name string

Name of the report.

Id string

Unique impact.com Id for the report. Will only appear if ApiAccessible: true.

Category enum

What kind of data the report retrieves. Reports created in the impact.com Data Lab and Forensiq reports cannot be retrieved or run via the Reports API.

View possible values
AdminReturns data about brand account user actions within your impact.com account.
BetaReturns data about a beta feature you are enrolled in. You will only see Beta reports for the beta features you are enrolled in.
ComplianceReturns data about partner compliance. Your account needs special privileges to view these reports.
Cross-ProgramReturns data about cross-platform functionality or use (e.g., mobile and web at the same time).
CustomReturns data from customized reports.
FinanceReturns data about the financial aspects of your account.
InsightsReturns data sourced from impact.com's Optimize product.
ListingReturns aggregated sets of data, like partner contact information.
OperationsReturns data on day-to-day occurrences, like which partners unsubscribed from mailing lists.
PerformanceReturns performance data, which can be aggregated in various ways.

Description string

Short explanation of what data a specific report shows.

ApiAccessible boolean

Whether the report can be run via API.

ApiRunUri string

If ApiAccessible: true, the Uri to run a specific report via API will appear. Will only appear if ApiAccessible: true. In some cases a report can only be run using the Jobs endpoint (i.e. asynchronously). If this is true for a report then the ApiRunUri value and the DeferredApiRunUri value will be the same.

DeferredApiRunUri string

If ApiAccessible: true, the Uri to run a specific report via API using the Jobs endpoint will appear. Will only appear if ApiAccessible: true.

MetaDataUri string

If ApiAccessible: true, the Uri to retrieve a specific report's documentation will appear. Will only appear if ApiAccessible: true.

RunUri string

If ApiAccessible: false, then the report cannot be run via API. To run the report, you will need to append its RunUri to the end of https://app.impact.com.

{
  "Name": "Performance by Media",
  "Id": "agency_performance_by_media",
  "Category": "Performance",
  "Description": "Displays performance data for your managed media sources.",
  "ApiAccessible": true,
  "ApiRunUri": "/Agencies/<AccountSID>/Reports/agency_performance_by_media",
  "MetaDataUri": "/Advertisers/<AccountSID>/Reports/agency_performance_by_media/MetaData"
}