Skip to main content
GET
/
v1
/
participants
/
{id}
/
activity
/
state-history
Get participant state history
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/activity/state-history \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.scrip.dev/v1/participants/{id}/activity/state-history"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.scrip.dev/v1/participants/{id}/activity/state-history', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/participants/{id}/activity/state-history",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.scrip.dev/v1/participants/{id}/activity/state-history"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/participants/{id}/activity/state-history")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/participants/{id}/activity/state-history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "changed_at": "2024-01-15T10:30:00Z",
      "event_id": "550e8400-e29b-41d4-a716-446655440002",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "region",
      "new_value": "us-east",
      "old_value": "us-west",
      "operation": "set",
      "program_id": "550e8400-e29b-41d4-a716-446655440003",
      "rule_id": "550e8400-e29b-41d4-a716-446655440004",
      "state_type": "attribute"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}
{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}
{
"code": "forbidden",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Insufficient permissions for this action"
}
{
"code": "not_found",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Resource not found"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}
Returns a unified timeline of state changes for a participant, 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
Filter by state_type and key to narrow results. Use state_type=tier with a program_id to isolate tier transitions. Filter by from / to on changed_at (when the state change was recorded), or by event_from / event_to on the originating event’s event_timestamp. Entries without an event fall back to their changed_at. Both pairs can be used simultaneously (AND semantics).
For usage patterns and examples, see the Participants guide.

Authorizations

X-API-Key
string
header
required

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

Path Parameters

id
string<uuid>
required

Participant 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) — filters on system ingestion time

to
string<date-time>

End of time window (RFC 3339) — filters on system ingestion time

event_from
string<date-time>

Start of event occurrence window (RFC 3339) — filters on event_timestamp

event_to
string<date-time>

End of event occurrence window (RFC 3339) — filters on event_timestamp

limit
integer

Maximum results (default 50, max 100)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

Response

State history entries

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results