API Reference

Retrieve report metadata

Retrieves the dynamic documentation (aka the metadata) for a report. A report's metadata can tell you more about the information you retrieve when you run a report via API.

Parameters

In order to retrieve the metadata for a report, enter the Id of the report as a path parameter and end the request with /MetaData.

Id required

Unique impact.com Id for the report. You can get the report Id from the List all reports endpoint.

Returns

Returns a report metadata object for the requested report. This request should never return an error.

Example Request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Reports/<Id>/MetaData' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example Response

{
  "Name": "Action Listing",
  "Id": "mp_action_listing_sku_fast",
  "Description": "Basic information on the actions that occurred during a specified date range.  The show button allows a view of SKU level data.",
  "Filters": [
    {
      "Name": "Action Status",
      "DataType": "String",
      "Format": ""
      },
    {
      "Name": "Program",
      "DataType": "String",
      "Format": ""
      },
    ...    
    ],
    "Attributes": [
      {
        "Name": "Referral_Date",
        "DataType": "Date (yyyy-MM-dd'T'HH:mm:ssZZ)",
        "Description": ""
        },
      {
        "Name": "Action_Date",
        "DataType": "Date (yyyy-MM-dd'T'HH:mm:ssZZ)",
        "Description": ""
        },
    ... 
    ],
  "RunUri": "/Mediapartners/<AccountSID>/Reports/mp_action_listing_sku_fast",
  "Uri": "/Mediapartners/<AccountSID>/Reports/mp_action_listing_sku_fast/MetaData"
}