# Models

## The Action object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"components":{"schemas":{"Action":{"type":"object","description":"Represents a conversion event credited to a partner.","properties":{"Id":{"type":"string","description":"Unique impact.com identifier for the action."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign (program) this action belongs to."},"CampaignName":{"type":"string","description":"Display name of the campaign."},"ActionTrackerId":{"type":"integer","description":"Unique identifier for the action tracker (event type) that recorded this action."},"ActionTrackerName":{"type":"string","description":"Display name of the action tracker (event type)."},"MediaPartnerId":{"type":"integer","description":"Unique identifier for the partner credited for this action."},"MediaPartnerName":{"type":"string","description":"Display name of the credited partner."},"State":{"type":"string","description":"Current state of the action.\n- `PENDING`: Awaiting locking date or manual approval. Actions that have been modified also carry this state.\n- `APPROVED`: Reached its locking date or was manually approved. Will pay out the partner. No further modifications permitted.\n- `REVERSED`: Was reversed and will not pay out the partner.\n","enum":["PENDING","APPROVED","REVERSED"]},"AdId":{"type":"integer","description":"Unique identifier for the ad creative that drove the winning click."},"Payout":{"type":"number","description":"Commission amount to be paid to the partner, in the currency specified by the `Currency` field."},"Amount":{"type":"number","description":"Revenue amount associated with the action (sale amount), in the currency specified by the `Currency` field."},"Currency":{"type":"string","description":"Three-letter ISO 4217 currency code for monetary values in this action."},"EventDate":{"type":"string","format":"date-time","description":"Timestamp of when the conversion event occurred."},"Oid":{"type":"string","description":"Your unique identifier for the order associated with this action."},"CustomerId":{"type":"string","description":"Your unique, non-PII identifier for the customer who made the conversion."},"Uri":{"type":"string","description":"Unique URI reference to this action object."}}}}}}
```

## The ActionItem object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"components":{"schemas":{"ActionItem":{"type":"object","description":"Represents a single line item within an action.","properties":{"Sku":{"type":"string","description":"Stock-keeping unit (SKU) or product identifier for the item."},"ItemName":{"type":"string","description":"Display name of the product."},"Category":{"type":"string","description":"Product category for the item."},"Quantity":{"type":"string","description":"Number of units of this product in the order."},"SaleAmount":{"type":"string","description":"Revenue amount for this line item."},"Payout":{"type":"number","description":"Commission amount for this line item."},"Uri":{"type":"string","description":"Unique URI reference to this action item object."}}}}}}
```

## The ActionUpdate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"components":{"schemas":{"ActionUpdate":{"type":"object","description":"Represents a single modification event in an action's lifecycle. Acts as a changelog entry.","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."},"State":{"type":"string","description":"The state of the action at the time of this update.","enum":["PENDING","APPROVED","REVERSED"]},"DeltaPayout":{"type":"number","description":"The change in the Payout value recorded by this update."},"DeltaAmount":{"type":"number","description":"The change in the Amount (sale amount) value recorded by this update."},"UpdateDate":{"type":"string","format":"date-time","description":"Timestamp of when this update was recorded."},"Uri":{"type":"string","description":"Unique URI reference to this action update object."}}}}}}
```

## The QueuedResponse object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Actions","version":"v11"},"components":{"schemas":{"QueuedResponse":{"type":"object","description":"Returned when a modification or reversal request has been accepted and queued for processing.","properties":{"Status":{"type":"string","description":"Indicates the status of the request. A successful submission returns `QUEUED`."},"QueuedUri":{"type":"string","description":"The URI of the API submission record, which can be used to track the status of the queued request."}}}}}}
```


---

# 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/brand-api-reference-v11/reference/actions/models.md?ask=<question>
```

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.