Skip to main content
GET
Get group state history
Returns a unified timeline of state changes for a group, including tags, counters, attributes, and tiers. Each entry includes:
  • state_type: what changed (tag, attribute, counter, or tier)
  • key: the specific key that was modified
  • operation: set or delete
  • old_value / new_value: the value before and after the change
  • event_id: present when the change was triggered by a rule during event processing
  • changed_by_api_key_id: present when the change was made via a direct API call
Use the state_type and key query parameters to filter results. Filter by state_type=tier and provide a program_id to isolate tier transitions.
For usage patterns and examples, see the Groups guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Group ID

Query Parameters

state_type
enum<string>

Filter by state type

Available options:
tag,
counter,
attribute,
tier
key
string

Filter by key

program_id
string<uuid>

Filter by program ID (for tier entries)

operation
enum<string>

Filter by operation

Available options:
set,
delete,
add,
remove,
auto_reset
from
string<date-time>

Start of time window (RFC 3339)

to
string<date-time>

End of time window (RFC 3339)

limit
integer

Maximum number of results

Required range: x >= 1
cursor
string

Pagination cursor

Response

State history entries

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results