PRODUCT
Follow

Resource URL

Depending on the API user that was created for you, use one of the following URLs:

  • https://api.sizmek.com/rest/tagManagers/activities/conversions

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

Note

Note: Confirm with your Sizmek customer success manager regarding the correct URL to use.

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:

    • We recommend that for any PUT method that updates an object, 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.

    • 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.

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

Depending on the API user that was created for you, use one of the following URLs:

  • GET https://api.sizmek.com/rest/tagManagers/activities/conversions?advertiserId=1083752459&from=0&max=250&order=asc&sort=name

  • GET https://adapi.sizmek.com/sas/tagManagers/activities/conversions?advertiserId=1083752459&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.

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

Depending on the API user that was created for you, use one of the following URLs:

  • GET https://api.sizmek.com/rest/tagManagers/activities/conversions/{conversion activity ID}

  • 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.

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

Depending on the API user that was created for you, use one of the following URLs:

  • POST https://api.sizmek.com/rest/tagManagers/activities/conversions

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

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

Depending on the API user that was created for you, use one of the following request formats:

  • POST https://api.sizmek.com/rest/tagManagers/activities/conversions 

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

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

Depending on the API user that was created for you, use one of the following URLs:

  • PUT https://api.sizmek.com/rest/tagManagers/activities/conversions/{conversion activity ID}

  • PUT 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 updated conversion activity resource.

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

Comments

Powered by Zendesk