API Reference

Run a report [Deprecation Planned]

Runs a report and returns the report records. Ensure to retrieve report metadata for the report you are running to obtain documentation for that report.

The example request and response only represents one possible report. List all reports see all of the reports available to run.

Commonly Required Parameters

SUBAID required for most reports

A program Id. Further refine the report to only retrieve data from a specific program.

StartDate required for most reports

From what date and time the report should retrieve data. See ISO 8601.

EndDate required for most reports

To what date and time the report should retrieve data. See ISO 8601.

Optional Parameters

RQueryIDx optional

Some reports, for example the Withdrawal Details report, are capable of returning more than one table in the response. Use the RQueryIDx parameter to specify which table you would like to view. Specify RQueryIDx=0 to return the first table, or RQueryIDx=1 to return the second, and so on.

If the RQueryIDx parameter is omitted from the query, the API will return the first table by default, which is equivalent to specifying RQueryIDx=0.

Returns

Returns an array of report records objects up to a limit dictated by @pagesize. Each entry in the array is a separate report record object. If no report record objects meet the criteria or if no report data is available, the resulting array will be empty. This request should never return an error.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Reports/adv_action_listing_fast_pm_only' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'SUBAID=1000'

Example Response

{
  "@page": "1",
  ...
  "Records": [
    {
      "date_joined": "2019-08-27T17:17:14-04:00",
      "insertion_order": "Public Terms",
      "Id": "1910893",
      "media_partner": "ACME Partner",
      "group_name": "",
      "Type": "Direct",
      "Url": "http://www.acme.partner.com",
      "company_phone": "8051231234",
      "Address1": "223 E. De La Guerra Street ",
      "Address2": "",
      "Address3": "",
      "City": "Santa Barbara",
      "State": "CALIFORNIA",
      "Country": "US",
      "PostalCode": "93101",
      "contact_name": "Partner Person",
      "Email": "[email protected]",
      "Work": "8057777777",
      "Cell": "8057777777",
      "Promotional_Method": "",
      "promotional_area": "US"
      },
    ...
  ]
}