reportStructure Object – API Help Center

reportStructure Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Sizmek Ad Suite (SAS) internal use) If the field was received in the GET call, include it in the PUT call.

Parameter	Description	Type	Required	Notes
attributeIDs	Attribute names. (Click here for a full list.) Note Note: This page is only accessible if you have access to SAS. If you do not have the proper permissions, please reach out to your team or Customer Success Manager.	Array of strings	Required	[ ["Placeholder"] "Advertiser Name" "Advertiser ID" ] Placeholder columns are empty columns in the report. Can be added anywhere in the attribute or metric collection. Must have at least one attribute.
attributeIdsOnColumns	Determines which dimensions are pivoted in the report.	Array of strings	Optional	View attributeIdsOnColumns values Conversion Activity: Conversion Tag Name Panel: Panel Name Video/Audio Asset: Video/Audio Asset Name Custom Interaction: Custom Interaction Name Note Note: Leave this field empty if you do not want a pivoted dimension in the report.
metricIDs	Metric names. (Click here for a full list.) Note Note: This page is only accessible if you have access to SAS. If you do not have the proper permissions, please reach out to your team or Customer Success Manager.	Array of strings	Required	[ ["Placeholder"] "Served Impressions" "Total Clicks" ] Placeholder columns are empty columns in the report. Can be added anywhere in the attribute or metric collection. Must have at least one metric. When selecting an impression metric, use "Served Impressions" for the metricIDs
timeBreakdown	Date resolution of the data.	String	Required	View timeBreakdown values Hour Day Week Month Year Total

Object JSON Example

...
"reportStructure": {
                "attributeIDs": [
                    "Campaign Name",
                    "Campaign ID",
                    "Placement Name",
                    "Placement ID"
                ],
                "attributeIDsOnColumns": [
                    "Conversion Tag Name"
                ],
                "metricIDs": [
                    "Served Impressions",
                    "Total Clicks",
                    "CTR"
                ],
                "timeBreakdown": "Month"
            },
            
...

Parent Objects

Report Object

reportStructure Object Definition

Note

Note

Note

Note

Object JSON Example

Parent Objects

Comments