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/activityRule

  • https://adapi.sizmek.com/sas/tagManagers/activityRule

Note

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

Objects Used by This Resource

HTTP Method and URI List

HTTP METHOD

URI

DESCRIPTION

GET

tagManagers/activityRule/

Retrieves multiple activity rules.

GET

tagManagers/activityRule/{RuleID}

Retrieves a single activity rule.

POST

tagManagers/activityRule

Creates a single activity rule.

POST

tagManagers/activityRule/saveActivityRules/{TagManagerID}

Creates and saves multiple activity rules.

PUT

tagManagers/activityRule/{RuleID}

Updates a single activity rule.

PUT

tagManagers/activityRule/{TagManagerID}

Updates multiple activity rules.

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 Multiple Activity Rules (GET)

Retrieves multiple activity rules. 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

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/activityRule?from=0&max=250&order=asc&sort=name&tagManagerId=1083759370

  • GET https://adapi.sizmek.com/sas/tagManagers/activityRule?from=0&max=250&order=asc&sort=name&tagManagerId=1083759370

Response Format

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

GET an Activity Rule (GET)

Retrieves a specific activity rule.

Request Query Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of activity rule to fetch.

Long

Required

Request Format

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

  • GET https://api.sizmek.com/rest/tagManagers/activityRule/{RuleID}

  • GET https://adapi.sizmek.com/sas/tagManagers/activityRule/{RuleID}

Response Format

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

Create an Activity Rule (POST)

Creates a new activity rule.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing activity rule 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/activityRule

  • POST https://adapi.sizmek.com/sas/tagManagers/activityRule

Response Format

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

Create Multiple Activity Rules (POST)

Creates and saves multiple activity rules.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing multiple activity rules 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/activityRule/saveActivityRules/{TagManagerID}

  • POST https://adapi.sizmek.com/sas/tagManagers/activityRule/saveActivityRules/{TagManagerID}

Response Format

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

Update an Existing Activity Rule (PUT)

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the activity rule.

Long

Required

Body

Request containing activity rule body to update.

JSON

Required

Request Format

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

  • PUT https://api.sizmek.com/rest/tagManagers/activityRule/{RuleID}

  • PUT https://adapi.sizmek.com/sas/tagManagers/activityRule/{RuleID}

Response Format

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

Update Multiple Activity Rules (PUT)

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the activity rule.

Long

Required

Body

Request containing activity rule body to update.

JSON

Required

Request Format

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

  • PUT https://api.sizmek.com/rest/tagManagers/activityRule/updateActivityRules/{TagManagerID}

  • PUT https://adapi.sizmek.com/sas/tagManagers/activityRule/updateActivityRules/{TagManagerID}

Response Format

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

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

Comments

Powered by Zendesk