# Action Updates
## List action updates
> Returns a list of action updates, which serve as a changelog for actions.\
> It is recommended to filter by a date range using \`StartDate\` and \`EndDate\`.\
> \
> \*\*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.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"ActionUpdate":{"type":"object","description":"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.","properties":{"Id":{"type":"string","description":"Unique identifier for this action update record."},"ActionId":{"type":"string","description":"Unique identifier for the parent action that was updated."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign this action belongs to."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type)."},"EventTypeId":{"type":"string","description":"Alias for ActionTrackerId. The unique identifier of the event type."},"EventTypeName":{"type":"string","description":"Display name of the event type (action tracker)."},"EventCode":{"type":"string","description":"The event code associated with the action tracker, if configured."},"MediaPartnerId":{"type":"integer","description":"Unique identifier for the partner credited for this action."},"State":{"type":"string","description":"The state of the action at the time of this update.","enum":["PENDING","APPROVED","REVERSED"]},"StateDetail":{"type":"string","description":"A short code providing additional detail about the action's state (e.g., `PAID`, `OVERDUE`)."},"StateDetailDescription":{"type":"string","description":"A plain-text description of the StateDetail code."},"AdId":{"type":"integer","description":"Unique identifier for the ad creative that drove the winning click."},"Disposition":{"type":"string","description":"The disposition code applied to this update (e.g., `IR_BLANK`, `ORDER_UPDATE`)."},"DeltaPayout":{"type":"number","description":"The change in payout value recorded by this update."},"DeltaAmount":{"type":"number","description":"The change in sale amount recorded by this update."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for monetary values in this update."},"Category":{"type":"string","description":"Product category of the item associated with this update."},"Sku":{"type":"string","description":"SKU of the item associated with this update."},"Quantity":{"type":"string","description":"Quantity of the item at the time of this update."},"CatalogName":{"type":"string","description":"Name of the product catalog entry associated with the item, if applicable."},"CatalogCategory":{"type":"string","description":"Category from the product catalog entry, if applicable."},"CatalogDescription":{"type":"string","description":"Description from the product catalog entry, if applicable."},"CatalogManufacturer":{"type":"string","description":"Manufacturer from the product catalog entry, if applicable."},"CatalogOriginalFormatCategory":{"type":"string","description":"Original format category from the product catalog entry, if applicable."},"CatalogSubCategory":{"type":"string","description":"Sub-category from the product catalog entry, if applicable."},"PayoutLevel":{"type":"string","description":"Indicates whether the payout is calculated at the order level or item level (e.g., `ORDER`, `ITEM`)."},"DefaultPayoutRate":{"type":"string","description":"The default payout rate defined in the event type settings."},"ContractId":{"type":"string","description":"The unique identifier for the contract (partnership agreement) associated with this action."},"UpdateDate":{"type":"string","format":"date-time","description":"Timestamp of when this update was recorded."},"LockingDate":{"type":"string","format":"date-time","description":"Date after which the action can no longer be modified."},"ClearingDate":{"type":"string","format":"date-time","nullable":true,"description":"Date when the commission is scheduled to clear."},"ActionDate":{"type":"string","format":"date-time","description":"Timestamp of the original conversion event."},"Oid":{"type":"string","description":"Your unique identifier for the order associated with the parent action."},"CustomerId":{"type":"string","description":"Your unique, non-PII identifier for the customer."},"CustomerStatus":{"type":"string","description":"The customer status label at the time of this update."},"SharedId":{"type":"string","description":"The Shared ID value from the winning click."},"ActionUri":{"type":"string","format":"uri-reference","description":"URI reference to the parent action object."},"Uri":{"type":"string","format":"uri-reference","description":"Unique URI reference to this action update object."}}}}},"paths":{"/Advertisers/{AccountSID}/ActionUpdates":{"get":{"summary":"List action updates","description":"Returns a list of action updates, which serve as a changelog for actions.\nIt is recommended to filter by a date range using `StartDate` and `EndDate`.\n\n**Date filtering constraints (effective 5 August 2024):**\n- `StartDate` cannot be more than 3 years in the past.\n- The range between `StartDate` and `EndDate` cannot exceed 45 days.\n- If neither is specified, only the past 7 days are returned.\n- If `StartDate` is specified, `EndDate` must also be specified.\n\n**Recommendation:** Use action lifecycle postbacks instead of this endpoint for near-realtime updates.\n","operationId":"listActionUpdates","tags":["Action Updates"],"parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique account identifier.","schema":{"type":"string"}},{"name":"CampaignId","in":"query","required":true,"description":"The ID of the campaign to view action updates for.","schema":{"type":"integer"}},{"name":"StartDate","in":"query","description":"Filters for updates with an UpdateDate on or after this value (ISO 8601 with time component). Must be used with EndDate.","schema":{"type":"string","format":"date-time"}},{"name":"EndDate","in":"query","description":"Filters for updates with an UpdateDate on or before this value (ISO 8601 with time component). Must be used with StartDate.","schema":{"type":"string","format":"date-time"}},{"name":"State","in":"query","description":"Filters updates to only those that match the State value passed.","schema":{"type":"string","enum":["PENDING","APPROVED","REVERSED"]}},{"name":"ActionDateStart","in":"query","description":"Filters for updates with an ActionDate (EventDate) on or after this value (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"ActionDateEnd","in":"query","description":"Filters for updates with an ActionDate (EventDate) on or before this value (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"LockingDateStart","in":"query","description":"Filters for updates with a LockingDate on or after this value (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"LockingDateEnd","in":"query","description":"Filters for updates with a LockingDate on or before this value (ISO 8601).","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"A paginated list of action update objects.","content":{"application/json":{"schema":{"type":"object","properties":{"ActionUpdates":{"type":"array","items":{"$ref":"#/components/schemas/ActionUpdate"}}}}}}}}}}}}
```
## Get action update details
> Retrieves the details for a specific update to an action by its unique ActionUpdateId.
```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"ActionUpdate":{"type":"object","description":"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.","properties":{"Id":{"type":"string","description":"Unique identifier for this action update record."},"ActionId":{"type":"string","description":"Unique identifier for the parent action that was updated."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign this action belongs to."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type)."},"EventTypeId":{"type":"string","description":"Alias for ActionTrackerId. The unique identifier of the event type."},"EventTypeName":{"type":"string","description":"Display name of the event type (action tracker)."},"EventCode":{"type":"string","description":"The event code associated with the action tracker, if configured."},"MediaPartnerId":{"type":"integer","description":"Unique identifier for the partner credited for this action."},"State":{"type":"string","description":"The state of the action at the time of this update.","enum":["PENDING","APPROVED","REVERSED"]},"StateDetail":{"type":"string","description":"A short code providing additional detail about the action's state (e.g., `PAID`, `OVERDUE`)."},"StateDetailDescription":{"type":"string","description":"A plain-text description of the StateDetail code."},"AdId":{"type":"integer","description":"Unique identifier for the ad creative that drove the winning click."},"Disposition":{"type":"string","description":"The disposition code applied to this update (e.g., `IR_BLANK`, `ORDER_UPDATE`)."},"DeltaPayout":{"type":"number","description":"The change in payout value recorded by this update."},"DeltaAmount":{"type":"number","description":"The change in sale amount recorded by this update."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for monetary values in this update."},"Category":{"type":"string","description":"Product category of the item associated with this update."},"Sku":{"type":"string","description":"SKU of the item associated with this update."},"Quantity":{"type":"string","description":"Quantity of the item at the time of this update."},"CatalogName":{"type":"string","description":"Name of the product catalog entry associated with the item, if applicable."},"CatalogCategory":{"type":"string","description":"Category from the product catalog entry, if applicable."},"CatalogDescription":{"type":"string","description":"Description from the product catalog entry, if applicable."},"CatalogManufacturer":{"type":"string","description":"Manufacturer from the product catalog entry, if applicable."},"CatalogOriginalFormatCategory":{"type":"string","description":"Original format category from the product catalog entry, if applicable."},"CatalogSubCategory":{"type":"string","description":"Sub-category from the product catalog entry, if applicable."},"PayoutLevel":{"type":"string","description":"Indicates whether the payout is calculated at the order level or item level (e.g., `ORDER`, `ITEM`)."},"DefaultPayoutRate":{"type":"string","description":"The default payout rate defined in the event type settings."},"ContractId":{"type":"string","description":"The unique identifier for the contract (partnership agreement) associated with this action."},"UpdateDate":{"type":"string","format":"date-time","description":"Timestamp of when this update was recorded."},"LockingDate":{"type":"string","format":"date-time","description":"Date after which the action can no longer be modified."},"ClearingDate":{"type":"string","format":"date-time","nullable":true,"description":"Date when the commission is scheduled to clear."},"ActionDate":{"type":"string","format":"date-time","description":"Timestamp of the original conversion event."},"Oid":{"type":"string","description":"Your unique identifier for the order associated with the parent action."},"CustomerId":{"type":"string","description":"Your unique, non-PII identifier for the customer."},"CustomerStatus":{"type":"string","description":"The customer status label at the time of this update."},"SharedId":{"type":"string","description":"The Shared ID value from the winning click."},"ActionUri":{"type":"string","format":"uri-reference","description":"URI reference to the parent action object."},"Uri":{"type":"string","format":"uri-reference","description":"Unique URI reference to this action update object."}}}}},"paths":{"/Advertisers/{AccountSID}/ActionUpdates/{ActionUpdateId}":{"get":{"summary":"Get action update details","description":"Retrieves the details for a specific update to an action by its unique ActionUpdateId.","operationId":"getActionUpdateById","tags":["Action Updates"],"parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Your unique account identifier.","schema":{"type":"string"}},{"name":"ActionUpdateId","in":"path","required":true,"description":"The unique identifier for the action update, obtainable from the list endpoint.","schema":{"type":"string"}}],"responses":{"200":{"description":"An action update object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionUpdate"}}}}}}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://integrations.impact.com/brand-api-reference/reference/actions/action-updates.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.