Submit a request
 
PRODUCT
Privacy Policy |  AAS Advertising Policy | Terms of Use
Cookie Preference
Follow
Last Update:
  viewable by end users
  editable by agents

Resource URL

https://adapi.sizmek.com/sas/tagManagers/activities/conversions

Objects Used by This Resource

The following objects are used by this endpoint:

HTTP Method and URI List

HTTP METHOD

URI

DESCRIPTION

GET

tagManagers/activities/conversions

Retrieves multiple conversion activities.

GET

tagManagers/activities/conversions/{ID}

Retrieves a single conversion activity.

POST

tagManagers/activities/conversions

Creates a single counter type conversion activity.

POST

tagManagers/activities/conversions

Creates a single sales type conversion activity.

PUT

tagManagers/activities/conversions/{Id}

Updates a conversion activity.

Method Examples and Request Parameters

Important

Important:

  • For PUT calls, do the following:

    • For any PUT method that updates an object, make sure that you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail or override the existing fields with the new values.

    • You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:

       { "result": { "type": "Advertiser", ... } }

      You should make the following modifications, including your specific modifications, to the json object that you submit for the request.

       { "entities": [{ "type": "Advertiser", ... }] }

  • For POST calls, do the following:

    • Include the fields marked as Required, as indicated in the corresponding Object article.

    • Format the JSON object as follows:

       { "entities": [{ "type": "Advertiser", ... }] }

GET All Conversion Activities (GET)

Retrieves multiple conversion activities. Can be filtered according to query parameters.

Request Query Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

from

Starting index by which to fetch new advertisers (for paging purposes).

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of advertisers to fetch (for each page).

Long

Required

q

Filtering options for the request (see here).

String

Optional

Example of query string: q={"1":{"RECENT":["1519203216427-1526889216427"]},"2":{"NAME":["smith"]}}

Note

Note: The date is according to the Unix epoch timestamp.

View values

Name

Description

Type

Notes

3rdPARTYACTIVITES

Number of 3rd party activities defined in the conversion activity.

Integer

ACCOUNT

Name of account to which the conversion activity belongs.

Long

ACCOUNTID

ID of the account to which the conversion activity belongs.

Long

ACTIVITYRULES

Number of activity rules in which this conversion activity exists.

Integer

ADVERTISER

Name of advertiser to which the conversion activity belongs.

String

ADVERTISERID

ID of the advertiser to which the conversion activity belongs.

Long

CREATEDBY

Name of the user that created the conversion activity.

Name

CREATEDON

Date conversion activity was created.

Long

TAGMANAGERS

Number of tag managers in which this conversion activity appears.

Integers

TYPE

Type of conversion activity.

String
View values

  • Amazon's Conversion - Counter

  • Amazon's Conversion - Sales

UPDATEDBY

Name of the user that was last to update the conversion activity.

String

UPDATEDON

Date of last update (Date epoch).

Long

order

Sort order ASC or DESC, required if sort field name is specified (see here).

String

Optional

Note

Note: Required if a sort field name is specified.

By default, the API response is ascending.

sort

Sort by field name (see here).

String

Optional

advertiserId

ID of advertiser.

Long

Required

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/activities/conversions?advertiserId=1234567890&from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the conversion activities' details.

Example
{
    "result": [{
        "type": "ConversionActivity",
        "name": "conversion",
        "advertiserId": "1083762300",
        "activityType": "ConversionCounter",
        "accessLevel": "Full",
        "conversion": {
            "type": "Conversion",
            "conversionCountingGroup": "Always",
            "currency": {
                "type": "Currency",
                "id": 1,
                "name": "USD",
                "currencyLetters": "USD",
                "value": null
            },
            "conversionGroup1": "111",
            "conversionGroup2": "222",
            "conversionGroup3": null,
            "conversionGroup4": null,
            "conversionGroup5": null,
            "value": 3
        },
        "activityParameter": [{
            "type": "ActivityParameter",
            "value": 1083753345,
            "name": "111",
            "rowId": "0"
        }],
        "thirdPartyIds": [
            1083878971
        ],
        "brandIds": [
            1083775029
        ],
        "advertiserName": "adv3333",
        "globalData": {
            "global": {
                "localAdvertisers": [{
                    "hasGlobalAdvertiserPermissionAccess": false,
                    "hasGlobalTagManagerPermissionAccess": true,
                    "id": 1073747395,
                    "name": "Advertiser",
                    "type": "AdvertiserIdName",
                    "accountId": 1073746500,
                    "accountName": "Testing Account"
                }],
                "type": "GlobalEntityData",
                "allowUserAccessToLocalAdvertisers": false
            },
            "local": null,
            "status": "Global",
            "type": "GlobalData"
        },
        "conversionGlobalData": []
    }]
}

GET a Conversion Activity (GET)

Retrieves specific conversion activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of conversion activity to fetch.

Long

Required

Request Format

GET https://adapi.sizmek.com/sas/tagManagers/activities/conversions/{conversion activity ID}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the conversion activity rule's details.

Example
{
    "result": {
        "type": "ConversionActivity",
        "name": "conversion",
        "advertiserId": "1083762304",
        "activityType": "ConversionCounter",
        "accessLevel": "Full",
        "conversion": {
            "type": "Conversion",
            "conversionCountingGroup": "Always",
            "currency": {
                "type": "Currency",
                "id": 1,
                "name": "USD",
                "currencyLetters": "USD",
                "value": null
            },
            "conversionGroup1": "111",
            "conversionGroup2": "222",
            "conversionGroup3": null,
            "conversionGroup4": null,
            "conversionGroup5": null,
            "value": 3
        },
        "activityParameter": [{
            "type": "ActivityParameter",
            "value": 1083753345,
            "name": "111",
            "rowId": "0"
        }],
        "thirdPartyIds": [
            1083878971
        ],
        "brandIds": [
            1083775029
        ],
        "advertiserName": "reut adv3333",
        "globalData": {
            "global": {
                "localAdvertisers": [{
                    "hasGlobalAdvertiserPermissionAccess": false,
                    "hasGlobalTagManagerPermissionAccess": true,
                    "id": 1073747395,
                    "name": "!!!eidanAdvertiser11072017",
                    "type": "AdvertiserIdName",
                    "accountId": 1073746545,
                    "accountName": "P2C Testing Account - Don't Touch"
                }],
                "type": "GlobalEntityData",
                "allowUserAccessToLocalAdvertisers": false
            },
            "local": null,
            "status": "Global",
            "type": "GlobalData"
        },
        "conversionGlobalData": []
    }
}

Create a Counter Type Conversion Activity (POST)

Create a new counter type conversion activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing conversion activity body to create.

JSON

Required

Request Format

POST https://adapi.sizmek.com/sas/tagManagers/activities/conversions

Example
{
    "entities": [{
       
        "type": "ConversionActivity",
        "name": "conversion",
        "advertiserId": "1083762404",
        "activityType": "ConversionCounter",
        "accessLevel": "Full",
        "conversion": {
            "type": "Conversion",
            "conversionCountingGroup": "Always",
            "currency": {
                "type": "Currency",
                "id": 1,
                "name": "USD",
                "currencyLetters": "USD",
                "value": null
            },
            "conversionGroup1": "111",
            "conversionGroup2": "222",
            "conversionGroup3": null,
            "conversionGroup4": null,
            "conversionGroup5": null,
            "value": 3
        },
        "activityParameter": [{
            "type": "ActivityParameter",
            "value": 1083753345,
            "name": "111",
            "rowId": "0"
        }],
        "thirdPartyIds": [
            1083878971
        ],
        "brandIds": [
            1083775029
        ],
        "advertiserName": "adv3333",
        "globalData": {
            "global": {
                "localAdvertisers": [{
                    "hasGlobalAdvertiserPermissionAccess": false,
                    "hasGlobalTagManagerPermissionAccess": true,
                    "id": 1073747395,
                    "name": "!!!Advertiser11072017",
                    "type": "AdvertiserIdName",
                    "accountId": 1073746545,
                    "accountName": "Testing Account"
                }],
                "type": "GlobalEntityData",
                "allowUserAccessToLocalAdvertisers": false
            },
            "local": null,
            "status": "Global",
            "type": "GlobalData"
        },
        "conversionGlobalData": []

    }
]      
    }

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the new counter type conversion activity resource.

Create a Sales Type Conversion Activity (POST)

Create a new sales type conversion activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

Notes

Body

Request containing sales type conversion activity body to create.

JSON

Required

Request Format

POST https://adapi.sizmek.com/sas/tagManagers/activities/conversions

Example
{
    "entities": [{
        "type": "ConversionActivity",
        "name": "conversion sales",
        "advertiserId": "1083762304",
        "activityType": "ConversionSale",
        "accessLevel": "Full",
        "conversion": {
            "type": "Conversion",
            "conversionCountingGroup":"OncePerBrowserSession",
            "currency": {
                "type": "Currency",
                "id": 1,
                "name": "USD",
                "currencyLetters": "USD",
                "value": null
            },
            "conversionGroup1": "11",
            "conversionGroup2": null,
            "conversionGroup3": null,
            "conversionGroup4": null,
            "conversionGroup5": null,
            "value": null
        },
        "activityParameter": [{
                "type": "ActivityParameter",
                "value": "",
                "name": "OrderID",
                "rowId": "0"
            },
            {
                "type": "ActivityParameter",
                "value": "",
                "name": "ProductID",
                "rowId": "1"
            },
            {
                "type": "ActivityParameter",
                "value": "",
                "name": "ProductInfo",
                "rowId": "2"
            },
            {
                "type": "ActivityParameter",
                "value": "",
                "name": "Quantity",
                "rowId": "3"
            },
            {
                "type": "ActivityParameter",
                "value": "",
                "name": "Value",
                "rowId": "4"
            }
        ],
        "thirdPartyIds": [
            1083878971
        ],
        "brandIds": null,
        "advertiserName": "adv3333",
        "globalData": {
            "global": {
                "localAdvertisers": [{
                    "hasGlobalAdvertiserPermissionAccess": false,
                    "hasGlobalTagManagerPermissionAccess": true,
                    "id": 1073747395,
                    "name": "!!!eidanAdvertiser11072017",
                    "type": "AdvertiserIdName",
                    "accountId": 1073746545,
                    "accountName": "Testing Account"Co
                }],
                "type": "GlobalEntityData",
                "allowUserAccessToLocalAdvertisers": false
            },
            "local": null,
            "status": "Global",
            "type": "GlobalData"
        },
        "conversionGlobalData": []
    }
    ]
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the new sales type conversion activity resource.

Update an Existing Conversion Activity (PUT)

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the conversion activity.

Long

Required

Body

Request containing conversion activity body to update.

JSON

Required

Request Format

PUT https://adapi.sizmek.com/sas/tagManagers/activities/conversions/{conversion activity ID}

Example
{
    "entities": [{
        "type": "ConversionActivity",
        "id": 1083743260,
        "relationsBag": {
            "parents": {
                "account": {
                    "id": 1073744288,
                    "name": "AccountDemo0",
                    "internal": false
                },
                "advertiser": {
                    "id": 1083762304,
                    "name": "adv3333"
                },
                "brand": null,
                "campaign": null,
                "site": null
            },
            "children": {
                "advertisers": {
                    "count": 0
                },
                "brands": {
                    "count": 0
                },
                "campaigns": {
                    "count": 0
                },
                "users": {
                    "count": 0
                }
            },
            "creativeAccountContact": false
        },
        
        "version": 1561884626825045200,
        "createdBy": 1073741831,
        "createdByName": "AdminUser",
        "createdByAccount": 1073741826,
        "createdByAccountName": "AdminAccount",
        "createdOn": 1561450585046,
        "lastUpdatedBy": null,
        "lastUpdatedByName": null,
        "lastUpdatedByAccount": null,
        "lastUpdatedByAccountName": null,
        "lastUpdateOn": 1561884626822,
        "name": "conversion sales_1",
        "activityType": "ConversionSale",
        "advertiserId": 1083762304,
        "rulesCount": 0,
        "tagManagersCount": 0,
        "conversionsCount": null,
        "tagManagerIds": [],
        "accessLevel": "Full",
        "nxtTagManagement": true,
        "conversion": {
            "type": "Conversion",
            "conversionCountingGroup": "OncePerBrowserSession",
            "currency": {
                "type": "Currency",
                "id": 1,
                "name": "USD",
                "currencyLetters": "USD"
            },
            "value": null,
            "conversionGroup1": "11",
            "conversionGroup2": "12",
            "conversionGroup3": null,
            "conversionGroup4": null,
            "conversionGroup5": null,
            "conversionGroup1Id": 3280389249770626,
            "conversionGroup2Id": null,
            "conversionGroup3Id": null,
            "conversionGroup4Id": null,
            "conversionGroup5Id": null
        },
        "activityParameter": [{
            "type": "ActivityParameter",
            "name": "OrderID",
            "value": null,
            "sequenceId": null,
            "paramType": "predefinedParam",
            "rowId": "0"
        }, {
            "type": "ActivityParameter",
            "name": "ProductID",
            "value": null,
            "sequenceId": null,
            "paramType": "predefinedParam",
            "rowId": "1"
        }, {
            "type": "ActivityParameter",
            "name": "ProductInfo",
            "value": null,
            "sequenceId": null,
            "paramType": "predefinedParam",
            "rowId": "2"
        }, {
            "type": "ActivityParameter",
            "name": "Quantity",
            "value": null,
            "sequenceId": null,
            "paramType": "predefinedParam",
            "rowId": "3"
        }, {
            "type": "ActivityParameter",
            "name": "Value",
            "value": null,
            "sequenceId": null,
            "paramType": "predefinedParam",
            "rowId": "4"
        }],
        "thirdPartyIds": [],
        "brandIds": null,
        "globalData": {
            "type": "GlobalData",
            "status": "Global",
            "global": {
                "type": "GlobalEntityData",
                "allowUserAccessToLocalAdvertisers": false,
                "localAdvertisers": [{
                    "type": "AdvertiserIdName",
                    "id": 1073747395,
                    "name": "!!!Advertiser11076017",
                    "accountId": 1073746545,
                    "accountName": "Testing Account",
                    "hasGlobalTagManagerPermissionAccess": true
                }]
            },
            "local": null
        },
        "conversionGlobalData": [],
        "conversionActivityCallsInTheLast24Hours": null,
        "httpStatusCode": 200,
        "route": "tagManagers/activities/conversions",
        "reqParams": null,
        "fromServer": true,
        "parentResource": null,
        "restangularCollection": false,
        "advertiserName": "asdv3333"
    }]
}

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the updated conversion activity resource.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments