Skip to main content
GET
/
accounts
/
api
/
account
/
settings
/
order
Get order settings
curl --request GET \
  --url https://api.upstackdata.com/accounts/api/account/settings/order \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'
{
  "orderSettings": {
    "countPendingOrders": true,
    "countVoidedOrders": true,
    "exclusionFilters": [
      {
        "name": "Exclude POS",
        "enabled": true,
        "conditionGroups": [
          {
            "conditions": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "value": "<string>"
              }
            ],
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Your Upstack API key. Starts with upstack_.

​
x-pixel-id
string
header
required

The pixel id the request targets.

Response

The current order settings.

​
orderSettings
object
required

Account-wide order analytics config. Drives every revenue, attribution, and cohort number across the dashboard and the public query API. Defaults when unset: countPendingOrders=false, countVoidedOrders=false, refundDateAttribution=refund_date, exclusionFilters=[].

PUT semantics are whole-object replace — any existing filter not present in the PUT body is deleted. Max 50 filters per account.