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 represent one possible report. List all reports see all of the reports available to run.
Parameters
In order to run a report, enter the Id
of the report as a path parameter.
SUBAID
required for most reports
SUBAID
required for most reportsA program Id. Further refine the report to only retrieve data from a specific program.
StartDate
required for most reports
StartDate
required for most reportsFrom what date and time the report should retrieve data. See ISO 8601.
EndDate
required for most reports
EndDate
required for most reportsTo what date and time the report should retrieve data. See ISO 8601.
Returns
Returns a report record object
for the requested report. This request should never return an error.
Example Request
curl 'https://api.impact.com/Mediapartners/<AccountSID>/Reports/<Id>' \
-X GET \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
Example Response
{
"@page": "1".
...
"Records": [
{
"Referral_Date": "",
"Action_Date": "2021-05-13T23:45:36-04:00",
"Locking_Date": "",
"Action_Id": "M.8882.4881.935157",
"Oid": "O65667",
"Campaign": "Acme Inc",
"Action_Tracker": "Sale",
"Property_Type": "",
"Property_Id": "",
"Property_Name": "",
"Status": "Pending",
"Status_Detail": "",
"SKU": "",
"Item_Name": "",
"Category": "",
"Quantity": "",
"Sale_Amount": "46.80",
"Original_Sale_Amount": "",
"Payout": "0.0000",
"VAT": "0.0000",
"Promo_Code": "mothersday",
"Sharedid": ""
},
...
]
}