Sizmek SAS connector reference

This reference explains in detail how to work with your Sizmek SAS marketing data in Adverity.

Prerequisites

Before you read this reference, perform all of the following actions:

• Create a Sizmek SAS datastream. For more information, see Collecting data from Sizmek SAS.

• Ensure the Report type of the Sizmek SAS datastream is set to Custom.

Configuring the Custom report settings

To configure the Custom report settings for a Sizmek SAS datastream, follow these steps:

1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Datastreams.

2. Select the Sizmek SAS datastream.

3. In the top navigation panel, click Settings.

4. In Report Type, ensure the value Custom is selected.

5. In Report pattern, copy and paste the API object from the Sizmek SAS user interface. You can enter a {start} placeholder into the dataStartTimestamp object to substitute the YYYY-MM-DD date. For example, the following dataStartTimestamp objects are applicable in the Custom report API:

   • "dataStartTimestamp": "2021-04-27T04:00:00.000Z"

   • "dataStartTimestamp": "{start}T04:00:00.000Z"

   • "dataStartTimestamp": "{start}"

   The {end} placeholder is available for the dataEndTimestamp object.

6. Click Save.

Example of a Sizmek SAS API report

Below is an example of an API query.

{
    "type": "AnalyticsReport",
    "reportName": "Example report",
    "reportScope": {
        "timeRange": {
            "timeZone": "Greenwich",
            "dataStartTimestamp": "2021-04-27T04:00:00.000Z",
            "dataEndTimestamp": "2021-04-30T03:59:59.999Z",
            "type": "Custom"
        },
        "entitiesHierarchy": {
            "entitiesHierarchyLevelType": "ADVERTISER",
            "accountContext": 12345,
            "accounts": [
                12345
            ],
            "advertisers": [
                100001
            ],
            "displayCampaignsIds": [],
            "searchCampaignsIds": [],
            "sites": [],
            "campaignsType": [
                "Display"
            ]
        },
        "attributionModelID": -1,
        "impressionCookieWindow": 0,
        "clickCookieWindow": 0,
        "filters": {
            "conversionTagIDs": [
                1234567,
                1345678,
                1456789,     
         ]
        },
        "currencyOptions": {
            "type": "Custom",
            "defaultCurrency": 1,
            "targetCurrency": 1,
            "currencyExchangeDate": "2021-04-30"
        },
        "presetId": null
    },
    "reportStructure": {
        "attributeIDs": [
            "Conversion Tag ID",
            "Conversion Tag Name",
            "Account ID",
            "Account Name",
            "Ad ID",
            "Ad Name",
            "Advertiser ID",
            "Advertiser Name",
            "Campaign Name",
            "Campaign ID",
            "Placement ID",
            "Placement Name",
            "Conversion Activity Type",
            "Global Conversion ID",
            "Is Global Conversion"
        ],
        "metricIDs": [
            "Total Conversions",
            "Post Click Conversions",
            "Post Impression Conversions",
            "Conversion Revenue"
        ],
        "attributeIDsOnColumns": [],
        "timeBreakdown": "Day"
    },
    "reportExecution": {
        "type": "Ad_Hoc"
    },
    "reportDeliveryMethods": [
        {
            "type": "URL",
            "exportFileType": "CSV",
            "compressionType": "NONE",
            "emailRecipients": [
                "Name@email.com"
            ],
            "exportFileNamePrefix": "Test",
            "appendTimestampToReportName": false
        }
    ],
    "reportAuthorization": {
        "type": "mm3",
        "userID": 0123456789,
        "ownerAccountId": 98765
    }
}
{
    "data": {
        "labels": [
            "foo",
            "bar"
        ],
        "series": [
            [ 0, 1, 2, 3 ],
            [ 0, -4, -8, -12 ]
        ]
    },
    // we even support comments
    "error": null,
    "status": "Ok"
}