Ctrlk
Help CenterContact Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Action Updates

List action updates

get

Returns a list of the action updates for the campaign. Action updates serve as a changelog, recording every modification to an action. The recommended approach is to filter by StartDate and EndDate based on the UpdateDate value.

Date filtering constraints (effective 5 August 2024):

  • StartDate cannot be more than 3 years in the past.

  • The range between StartDate and EndDate cannot exceed 45 days.

  • If neither is specified, only the past 7 days are returned.

  • If StartDate is specified, EndDate must also be specified.

Recommendation: Use action lifecycle postbacks instead of this endpoint for near-realtime updates.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired

Your unique account identifier.

Query parameters
CampaignIdintegerRequired

The ID of the campaign to list action updates for.

Example: 1000
StartDatestring · date-timeOptional

Filters for updates with an UpdateDate on or after this value (ISO 8601 with time component). Must be used with EndDate.

Example: 2024-01-01T00:00:00Z
EndDatestring · date-timeOptional

Filters for updates with an UpdateDate on or before this value (ISO 8601 with time component). Must be used with StartDate.

Example: 2024-01-31T23:59:59Z
Statestring · enumOptional

Filters the list to updates that match the specified State value.

Example: PENDINGPossible values:
ActionDateStartstring · date-timeOptional

Filters for updates with an ActionDate (EventDate) on or after this value (ISO 8601).

Example: 2024-01-01T00:00:00Z
ActionDateEndstring · date-timeOptional

Filters for updates with an ActionDate (EventDate) on or before this value (ISO 8601).

Example: 2024-01-31T23:59:59Z
LockingDateStartstring · date-timeOptional

Filters for updates with a LockingDate on or after this value (ISO 8601).

Example: 2024-01-01T00:00:00Z
LockingDateEndstring · date-timeOptional

Filters for updates with a LockingDate on or before this value (ISO 8601).

Example: 2024-01-31T23:59:59Z
Responses
200

An array of action update objects.

application/json
get/Advertisers/{AccountSID}/ActionUpdates
200

An array of action update objects.

Get action update by ID

get

Retrieves the details for a specific update to an action by its unique ActionUpdateId.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired

Your unique account identifier.

ActionUpdateIdstringRequired

The unique identifier for the action update, obtainable from the list endpoint.

Example: 1000.4636.158133.95095059
Responses
200

An action update object.

application/json

Represents a single modification event in an action's lifecycle. Each time an action changes state or is modified, a new ActionUpdate record is created.

IdstringOptional

Unique identifier for this action update record.

Example: 1000.4636.158133.95095059
ActionIdstringOptional

Unique identifier for the parent action that was updated.

Example: 1000.4636.158133
CampaignIdintegerOptional

Unique identifier for the campaign this action belongs to.

Example: 1000
ActionTrackerIdintegerOptional

Unique identifier for the action tracker (event type).

Example: 2240
MediaPartnerIdintegerOptional

Unique identifier for the partner credited for this action.

Example: 10000
Statestring · enumOptional

The state of the action at the time of this update.

Example: PENDINGPossible values:
StateDetailstringOptional

A short code providing additional detail about the action's state (e.g., PAID, OVERDUE).

AdIdintegerOptional

Unique identifier for the ad creative that drove the winning click.

Example: 506720
DeltaPayoutnumberOptional

The change in payout value recorded by this update.

Example: 0.65
DeltaAmountnumberOptional

The change in sale amount recorded by this update.

Example: 16.29
CategorystringOptional

Product category of the item associated with this update.

Example: Sports
SkustringOptional

SKU of the item associated with this update.

Example: 12345
QuantitystringOptional

Quantity of the item at the time of this update.

Example: 2
CatalogNamestringOptional

Name of the product catalog entry associated with the item, if applicable.

CatalogCategorystringOptional

Category from the product catalog entry associated with the item, if applicable.

UpdateDatestring · date-timeOptional

Timestamp of when this update was recorded.

Example: 2020-09-10T10:51:23-07:00
LockingDatestring · date-timeOptional

Date after which the action can no longer be modified.

Example: 2020-09-26T00:00:00-07:00
ClearingDatestring · date-time · nullableOptional

Date when the commission is scheduled to clear.

Example: 2020-09-30T00:00:00-07:00
ActionDatestring · date-timeOptional

Timestamp of the original conversion event.

Example: 2020-09-10T10:42:38-07:00
OidstringOptional

Your unique identifier for the order associated with the parent action.

Example: 9217374917472
CustomerIdstringOptional

Your unique, non-PII identifier for the customer.

Example: BCZ2WVSH674563PDPYOTM3AXDQ
CustomerStatusstringOptional

The customer status label at the time of this update.

SharedIdstringOptional

The Shared ID value from the winning click.

Example: RT-19247423
ActionUristringOptional

URI reference to the parent action object.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133
UristringOptional

Unique URI reference to this action update object.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/ActionUpdates/1000.4636.158133.95095059
get/Advertisers/{AccountSID}/ActionUpdates/{ActionUpdateId}
200

An action update object.

PreviousActionsNextModels

Last updated