Runs a report and returns the report records. Be sure to retrieve report metadata for the report you are running to obtain documentation for parameters specific to that report. Read how to migrate to the ReportExport API Endpoint.

The example request and response only represents one possible report.

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 the report should retrieve data. Time is not supported. See ISO 8601.

`EndDate` required for most reports

To what date the report should retrieve data. Time is not supported. 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 record 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/Agencies/<AccountSID>/Reports/agency_performance_by_campaign' \
  -G \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \

Example reponse

{
  "@page": "1",
  ...
  "Records": [
    {
      "Campaign": "Demand Side Partner Program 1",
      "campaign_id": "13413",
      "Id": "13413",
      "Media": "1",
      "Imps": "0",
      "raw_clicks": "",
      "Clicks": "18423",
      "Calls": "0",
      "Answered": "",
      "Sales": "",
      "Leads": "",
      "Dataposts": "",
      "Two_Tiers": "",
      "Converted_Calls": "",
      "Other_Actions": "",
      "Mobile_Installs": "",
      "Other_Mobile_Actions": "",
      "Actions": "10543",
      "Bonuses": "0",
      "Sale_Amount": "2082577.610000000000000000",
      "Sale_Revenue": "",
      "Datapost_Sale_Amount": "",
      "Call_Sale_Amount": "",
      "Sale_Cost": "",
      "Lead_Cost": "",
      "Datapost_Cost": "",
      "Other_Cost": "",
      "Two_Tier_Cost": "",
      "Call_Cost": "",
      "CPC_Deal_Cost": "323.860000000000000000",
      "Mobile_Install_Cost": "",
      "Other_Mobile_Cost": "",
      "Action_Cost": "72583.930000000000000000",
      "Bonus_Cost": "0E-18",
      "Total_Cost": "72907.790000000000000000",
      "Client_Cost": "",
      "AOV": "",
      "Sale_CR": "",
      "Lead_CR": "",
      "Sale_CPA": "",
      "Lead_CPA": "",
      "CPC": "3.9398539868642457797319"
    },
    {
      ...
    }
  ]
}