Reports (Legacy)

List all reports

get

Retrieves a list of all reports available to the brand account.

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Responses

200

A list of report metadata objects.

application/json

get/Advertisers/{AccountSID}/Reports

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Reports' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

A list of report metadata objects.

{
  "Reports": [
    {
      "Name": "DEFAULT_MODEL",
      "Id": "adv_action_listing_pm",
      "Category": "Performance",
      "Description": "Lists all actions for a date range.",
      "ApiAccessible": true,
      "ApiRunUri": "/Advertisers/<AccountSID>/Reports/adv_action_listing_pm",
      "DeferredApiRunUri": "/Advertisers/<AccountSID>/ReportExport/adv_action_listing_pm",
      "MetaDataUri": "/Advertisers/<AccountSID>/ReportsMetadata/adv_action_listing_pm",
      "RunUri": "https://app.impact.com/secure/reports/run/adv_action_listing_pm"
    }
  ]
}

Run a report [Deprecation Planned]

get

Directly retrieves report records. Note that page size is fixed at 20,000 records regardless of input. Use ReportExport for large sets.

Overload handling: When the reporting service is under heavy load this endpoint returns 503 with a Retry-After header. Wait the indicated number of seconds before retrying.

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

ReportIdstringRequired

The unique ID or handle of the report to run.

Query parameters

SUBAIDintegerRequired

The Program ID to filter report data.

StartDatestring · dateRequired

Start date for the report (YYYY-MM-DD).

EndDatestring · dateRequired

End date for the report (YYYY-MM-DD).

RQueryIDxintegerOptional

Specify which table to view if the report returns multiple tables.

Default: 0

Responses

200

A list of report records.

application/json

408

The report query exceeded the server-side timeout. Retry later or use the ReportExport endpoint for large datasets which run asynchronously without a timeout.

application/json

503

The reporting service is temporarily busy. Wait the number of seconds specified in the Retry-After response header before retrying. For large datasets, use the ReportExport endpoint to avoid this condition entirely.

application/json

get/Advertisers/{AccountSID}/Reports/{ReportId}

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Reports/{ReportId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "Records": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Retrieve report metadata

get

Retrieves dynamic documentation for a report, including available filters and output attributes.

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

ReportIdstringRequired

The unique ID or handle of the report.

Responses

200

The metadata object for the requested report.

application/json

NamestringOptional

The display name of the report.

Example: Action Listing

IdstringOptional

The unique identifier or handle for the report.

Example: adv_action_listing_pm

DescriptionstringOptional

A description of what the report contains.

Example: Lists all actions for a date range.

RunUristring · uri-referenceOptional

The URI to run this report.

Example: /Advertisers/<AccountSID>/Reports/adv_action_listing_pm

Uristring · uri-referenceOptional

The unique reference to this metadata object in the impact.com API.

Example: /Advertisers/<AccountSID>/ReportsMetadata/adv_action_listing_pm

get/Advertisers/{AccountSID}/Reports/{ReportId}/MetaData

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Reports/{ReportId}/MetaData' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

The metadata object for the requested report.

{
  "Name": "Action Listing",
  "Id": "adv_action_listing_pm",
  "Description": "Lists all actions for a date range.",
  "Filters": [
    {
      "Name": "START_DATE",
      "DataType": "DATE",
      "Format": "yyyy-MM-dd"
    }
  ],
  "Attributes": [
    {
      "Name": "ActionDate",
      "DataType": "DATETIME",
      "Description": "Date the action occurred."
    }
  ],
  "RunUri": "/Advertisers/<AccountSID>/Reports/adv_action_listing_pm",
  "Uri": "/Advertisers/<AccountSID>/ReportsMetadata/adv_action_listing_pm"
}