Actions API endpoints
Endpoint reference for the Actions tag (14 endpoints): Conversion action management
Conversion action management. 14 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.
GET /rest-api/action/{actionKey}.do
Get action by action key.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
actionKey | path | string | yes | The unique action key string that identifies the action. |
campaignId | query | integer | no | Optional campaign ID. When provided, the response includes the computed pixelKey for this campaign context (advertiserID + campaignID + actionID). |
Responses: 200 — Action object with id, key, name, conversion time frames, and optionally a campaign-specific pixelKey · 404 — No action found with the given action key. Errors follow the shared conventions.
DELETE /rest-api/action/{key}/delete.do
Delete action by action key.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
key | path | string | yes | The unique action key string identifying the action to delete. |
Responses: 200 — Action deleted successfully (empty 200 response) · 404 — No action found with the given action key, or it is already deleted. Errors follow the shared conventions.
POST /rest-api/action/{key}/update.do
Update action by action key.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
key | path | string | yes | The unique action key string identifying the action to update. |
name | form | string | no | New display name for the action, up to 64 characters and not blank. If omitted, the existing name is preserved. |
clickToConversionTimeFrame | form | integer | no | Click-to-conversion attribution window duration, 0 to 255 units. Defines how long after a click a conversion can be attributed to the ad. |
clickToConversionTimeFramePeriodType | form | string | no | Time unit for clickToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
viewToConversionTimeFrame | form | integer | no | View-to-conversion attribution window duration, 0 to 255 units. Defines how long after an ad view/impression a conversion can be attributed. |
viewToConversionTimeFramePeriodType | form | string | no | Time unit for viewToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
applyAttributionWindowToServerToServer | form | boolean | no | Whether the attribution window is also applied to server-to-server conversions. Server-to-server postbacks carry no impression or click identity of their own, so this is off for actions created before the option existed and on for new ones. Omit to keep the current value. |
rejectDuplicateConversions | form | boolean | no | Whether a repeat of the same event on one click is thrown away. Off by default: repeats count. Applies to both server-to-server postbacks and the cookie pixel. A tracking-event action repeats by definition and is exempt regardless. |
defaultAttributionType | form | string | no | Attribution type applied to a conversion that arrives with no attribution of its own — the last resort, below the action’s tracking event, the partner’s att= parameter and the classification carried by the tracking token. Allowed values: UNSPECIFIED, POST_CLICK, POST_VIEW (or integer IDs 0, 1, 2). Omit to keep the current value. Values: UNSPECIFIED, POST_CLICK, POST_VIEW. |
Responses: 200 — The updated action, in the shape the action GET returns · 404 — No action found with the given action key. Errors follow the shared conventions.
POST /rest-api/action/create.do
Create a new action.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | form | string | yes | Display name for the new action (e.g., ‘Purchase’, ‘Sign Up’, ‘App Install’), up to 64 characters. |
clickToConversionTimeFrame | form | integer | no | Click-to-conversion attribution window duration, 0 to 255 units. For example, 7 with DAY means conversions within 7 days of a click are attributed. |
clickToConversionTimeFramePeriodType | form | string | no | Time unit for clickToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
viewToConversionTimeFrame | form | integer | no | View-to-conversion attribution window duration, 0 to 255 units. For example, 1 with DAY means conversions within 1 day of an impression are attributed. |
viewToConversionTimeFramePeriodType | form | string | no | Time unit for viewToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
applyAttributionWindowToServerToServer | form | boolean | no | Whether the attribution window is also applied to server-to-server conversions. Server-to-server postbacks carry no impression or click identity of their own, so this is off for actions created before the option existed and on for new ones. Omit to keep the current value. |
rejectDuplicateConversions | form | boolean | no | Whether a repeat of the same event on one click is thrown away. Off by default: repeats count. Applies to both server-to-server postbacks and the cookie pixel. A tracking-event action repeats by definition and is exempt regardless. |
defaultAttributionType | form | string | no | Attribution type applied to a conversion that arrives with no attribution of its own — the last resort, below the action’s tracking event, the partner’s att= parameter and the classification carried by the tracking token. Allowed values: UNSPECIFIED, POST_CLICK, POST_VIEW (or integer IDs 0, 1, 2). Omit to keep the current value. Values: UNSPECIFIED, POST_CLICK, POST_VIEW. |
campaignId | form | integer | no | Optional campaign ID. When provided, the response includes the computed pixelKey for this campaign context. |
Responses: 200 — Newly created action object with id, key, name, conversion time frames, and optionally a campaign-specific pixelKey. Errors follow the shared conventions.
GET /rest-api/action/id/{id}.do
Get action by ID.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | The numeric database ID of the action to retrieve. |
campaignId | query | integer | no | Optional campaign ID. When provided, the response includes the computed pixelKey for this campaign context (advertiserID + campaignID + actionID). |
Responses: 200 — Action object with id, key, name, conversion time frames, and optionally a campaign-specific pixelKey · 404 — No action found with the given numeric ID. Errors follow the shared conventions.
GET /rest-api/action/id/{id}/tracking-code.do
Get the conversion tracking code of an action.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | The numeric database ID of the action |
campaignId | query | integer | no | Campaign the codes are for; required for the pixel |
host | query | string | no | Ad-serving domain to build the codes on; one of the selectable domains |
Responses: 200 — The tracking codes the caller may see, under postback and/or pixel · 404 — Action or campaign not found. Errors follow the shared conventions.
POST /rest-api/action/id/{id}/update.do
Update action by ID.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | The numeric database ID of the action to update. |
name | form | string | no | New display name for the action, up to 64 characters and not blank. If omitted, the existing name is preserved. |
clickToConversionTimeFrame | form | integer | no | Click-to-conversion attribution window duration, 0 to 255 units. Defines how long after a click a conversion can be attributed to the ad. |
clickToConversionTimeFramePeriodType | form | string | no | Time unit for clickToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
viewToConversionTimeFrame | form | integer | no | View-to-conversion attribution window duration, 0 to 255 units. Defines how long after an ad view/impression a conversion can be attributed. |
viewToConversionTimeFramePeriodType | form | string | no | Time unit for viewToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
applyAttributionWindowToServerToServer | form | boolean | no | Whether the attribution window is also applied to server-to-server conversions. Server-to-server postbacks carry no impression or click identity of their own, so this is off for actions created before the option existed and on for new ones. Omit to keep the current value. |
rejectDuplicateConversions | form | boolean | no | Whether a repeat of the same event on one click is thrown away. Off by default: repeats count. Applies to both server-to-server postbacks and the cookie pixel. A tracking-event action repeats by definition and is exempt regardless. |
defaultAttributionType | form | string | no | Attribution type applied to a conversion that arrives with no attribution of its own — the last resort, below the action’s tracking event, the partner’s att= parameter and the classification carried by the tracking token. Allowed values: UNSPECIFIED, POST_CLICK, POST_VIEW (or integer IDs 0, 1, 2). Omit to keep the current value. Values: UNSPECIFIED, POST_CLICK, POST_VIEW. |
Responses: 200 — The updated action, in the shape the action GET returns · 404 — No action found with the given numeric ID. Errors follow the shared conventions.
GET /rest-api/actions.do
Get all actions shared to user.
No parameters beyond authentication.
Responses: 200 — JSON array of action objects with id, key, name, and conversion time frame settings. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/action/{actionKey}.do
Get campaign action by action key (deprecated) (deprecated)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | The numeric ID of the campaign. Used for context when generating the action key in the response. |
actionKey | path | string | yes | The unique action key string that identifies the action. |
Responses: 200 — Action object with key, id, name, and conversion time frame settings · 404 — No action found with the given action key. Errors follow the shared conventions.
DELETE /rest-api/campaign/{campaignId}/action/{key}/delete.do
Delete campaign action (deprecated) (deprecated)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Campaign ID (kept for backward compatibility, not used in deletion). |
key | path | string | yes | The unique action key string identifying the action to delete. |
Responses: 200 — Action deleted successfully (empty 200 response) · 404 — No action found with the given action key, or it is already deleted. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/action/{key}/update.do
Update campaign action (deprecated) (deprecated)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Campaign ID (kept for backward compatibility, not used in lookup). |
key | path | string | yes | The unique action key string identifying the action to update. |
name | form | string | no | New display name for the action, up to 64 characters and not blank. If omitted, the existing name is preserved. |
clickToConversionTimeFrame | form | integer | no | Click-to-conversion attribution window duration, 0 to 255 units. Defines how long after a click a conversion can be attributed to it. |
clickToConversionTimeFramePeriodType | form | string | no | Time unit for clickToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
viewToConversionTimeFrame | form | integer | no | View-to-conversion attribution window duration, 0 to 255 units. Defines how long after an ad impression a conversion can be attributed to it. |
viewToConversionTimeFramePeriodType | form | string | no | Time unit for viewToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
applyAttributionWindowToServerToServer | form | boolean | no | Whether the attribution window is also applied to server-to-server conversions. Server-to-server postbacks carry no impression or click identity of their own, so this is off for actions created before the option existed and on for new ones. Omit to keep the current value. |
rejectDuplicateConversions | form | boolean | no | Whether a repeat of the same event on one click is thrown away. Off by default: repeats count. Applies to both server-to-server postbacks and the cookie pixel. A tracking-event action repeats by definition and is exempt regardless. |
defaultAttributionType | form | string | no | Attribution type applied to a conversion that arrives with no attribution of its own — the last resort, below the action’s tracking event, the partner’s att= parameter and the classification carried by the tracking token. Allowed values: UNSPECIFIED, POST_CLICK, POST_VIEW (or integer IDs 0, 1, 2). Omit to keep the current value. Values: UNSPECIFIED, POST_CLICK, POST_VIEW. |
Responses: 200 — The updated action, in the shape the action GET returns · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/action/create.do
Create action for campaign (deprecated) (deprecated)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | form | string | yes | Display name for the new action (e.g., ‘Purchase’, ‘Sign Up’), up to 64 characters. |
campaignId | path | integer | yes | The numeric ID of the campaign to associate the action with. Used to compute the action key in the response. |
clickToConversionTimeFrame | form | integer | no | Click-to-conversion attribution window duration, 0 to 255 units. |
clickToConversionTimeFramePeriodType | form | string | no | Time unit for clickToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
viewToConversionTimeFrame | form | integer | no | View-to-conversion attribution window duration, 0 to 255 units. |
viewToConversionTimeFramePeriodType | form | string | no | Time unit for viewToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. Values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR. |
applyAttributionWindowToServerToServer | form | boolean | no | Whether the attribution window is also applied to server-to-server conversions. Server-to-server postbacks carry no impression or click identity of their own, so this is off for actions created before the option existed and on for new ones. Omit to keep the current value. |
rejectDuplicateConversions | form | boolean | no | Whether a repeat of the same event on one click is thrown away. Off by default: repeats count. Applies to both server-to-server postbacks and the cookie pixel. A tracking-event action repeats by definition and is exempt regardless. |
defaultAttributionType | form | string | no | Attribution type applied to a conversion that arrives with no attribution of its own — the last resort, below the action’s tracking event, the partner’s att= parameter and the classification carried by the tracking token. Allowed values: UNSPECIFIED, POST_CLICK, POST_VIEW (or integer IDs 0, 1, 2). Omit to keep the current value. Values: UNSPECIFIED, POST_CLICK, POST_VIEW. |
Responses: 200 — Newly created action object with id, name, key, and conversion time frame settings · 404 — Not found — resource does not exist. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/action/id/{id}.do
Get campaign action by ID (deprecated) (deprecated)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | The numeric ID of the campaign. Used to compute the action key in the response. |
id | path | integer | yes | The numeric ID of the action to retrieve. |
Responses: 200 — Action object with key, id, name, and conversion time frame settings · 404 — No action found with the given numeric ID. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/actions.do
Get actions with keys for campaign.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | The numeric ID of the campaign whose actions to retrieve. The campaign must have actions enabled. |
Responses: 200 — JSON array of action objects, each with key, pixelKey, name, and conversion time frame settings · 404 — No such campaign. Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
- Network services and miscellaneous APIs
