Skip to content
Tallyraydocs

Offers' daily caps today: what attribution counted, and whether each is reached

GET
/v1/buyer/offer-caps
curl --request GET \
  --url https://example.com/v1/buyer/offer-caps \
  --header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the buyer:read or buyer:write scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

offer_id
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
count
required
integer format: int64
daily_cap
required
integer format: int64
offer
required
object
id
required
integer format: int64
name
string
period_end
required
string format: date-time
period_start
required
string format: date-time
reached
required
boolean
sequence
required
integer format: int64
updated_at
required
string | null format: date-time
workspace_id
required
integer format: int64
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example generated

{
  "data": [
    {
      "count": 1,
      "daily_cap": 1,
      "offer": {
        "id": 1,
        "name": "example"
      },
      "period_end": "2026-04-15T12:00:00Z",
      "period_start": "2026-04-15T12:00:00Z",
      "reached": true,
      "sequence": 1,
      "updated_at": "2026-04-15T12:00:00Z",
      "workspace_id": 1
    }
  ],
  "meta": {
    "next_page_token": "example",
    "total": 1,
    "total_approximate": true
  }
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}