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

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

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

Retrieves all 3rd party activities.

GET

/tagManagers/thirdparty/{id}

Retrieves a 3rd party activity by ID.

POST

/tagManagers/thirdparty

Creates a 3rd party activity.

PUT

/tagManagers/thirdparty/{id}

Updates an existing 3rd party activity.

DELETE

/tagManagers/thirdparty/{id}

Deletes a 3rd party activity.

POST

/tagManagers/thirdparty/delete

Deletes 3rd party activities in bulk.

GET

/tagManagers/thirdparty/existsInConversion/{id}

Searches for 3rd party activities that exist in the conversion activity.

GET

/tagManagers/thirdparty/getByConversionId/{id}

Determines whether a 3rd party activity exists in 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 3rd Party Activities (GET)

Retrieves multiple 3rd party activities. Can be filtered according to query parameters.

Request Query Parameters

Name

Description

Type

Required

Notes

from

Starting index by which to fetch new 3rd party activities for paging purposes.

Long

Required

Getting multiple entities requires using from and max query parameters.

max

Maximum number of 3rd party activities to fetch for each page.

Long

Required

q

Filtering options for the request (see here).

String

Optional

Example of query string: q={"1":{"CREATEDBYNAME":["MonicaSmith"]},"2":{"ADVERTISERNAME":["autoads"]}}

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

Advertiser ID from which to retrieve tag manager.

Long

Optional

enrichWithEntitiesCounts

Determines whether to enrich tag manager with related entities' counts.

Boolean

Optional

Specify true if counts are required; otherwise, counts will be zero and performance is improved.

Request Format

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

  • https://api.sizmek.com/rest/tagManagers/thirdparty?from=0&max=250

  • https://adapi.sizmek.com/sas/tagManager/thirdparty?from=0&max=250

Note

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

Response Format

GET a 3rd Party Activity (GET)

Retrieve a 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of 3rd party 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/thirdparty/{id}

  • GET https://adapi.sizmek.com/sas/tagManagers/thirdparty/{id}

Response Format

Create a 3rd Party Activity (POST)

Create a new 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

Body

Request containing 3rd party 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/thirdparty

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

Response Format

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

Update an Existing 3rd Party Activity (PUT)

Updates an existing 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

ID

ID of the 3rd party activity.

Long

Required

Body

Request containing 3rd party activity 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/thirdparty/{id}

  • PUT https://adapi.sizmek.com/sas/thirdparty{id}

Response Format

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

Delete a 3rd Party Activity (DELETE)

Deletes a single 3rd party activity.

Request Parameters

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

id

ID of 3rd party activity to delete.

Long

Required

Request Format

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

  • DELETE https://api.sizmek.com/rest/tagManagers/thirdparty/{id}

  • DELETE https://adapi.sizmek.com/sas/tagManagers/thirdparty/{id}

Response Format

A successful request returns the HTTP 200 OK status code; the requested 3rd party activity is deleted.

Delete 3rd Party Activities in Bulk (POST)

Deletes a single 3rd party activity.

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/thirdparty/delete

  • POST https://adapi.sizmek.com/sas/tagManagers/thirdparty/delete

Response Format

A successful request returns the HTTP 200 OK status code; the 3rd party activities are deleted.

Retrieve 3rd Party Activity in a Conversion Activity (GET)

Retrieves a 3rd party activity within a conversion activity.

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/thirdparty/getByConversionId/{ConversionActivityID}?from=0&max=250&order=asc&sort=name

  • POST https://adapi.sizmek.com/sas/tagManagers/thirdparty/getByConversionId/{ConversionActivityID}?from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code and an array of the 3rd party activities in the conversion activity.

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

Comments

Powered by Zendesk