Counters | Orishare docs

List counter definitions with readiness

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Response Body

`application/json`

curl -X GET "https://example.com/counter_definitions"

{  "data": [    {      "id": "string",      "name": "string",      "event": "string",      "window": "none",      "filter": null,      "status": "backfilling",      "backfill": {        "cutoff": "string",        "pending_events": 0      },      "created_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Register a historical counter; backfilling until history is counted

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Match^[a-z][a-z0-9_]{0,59}$

event*string

Length1 <= length

window?string

Value in

"none"
"day"
"week"
"month"
"year"

filter?unknown

Any JSON value (object, array, string, number, boolean or null). Kept non-recursive in the OpenAPI document.

Response Body

`application/json`

curl -X POST "https://example.com/counter_definitions" \  -H "Content-Type: application/json" \  -d '{    "name": "purchased_content",    "event": "content.purchased",    "window": "none"  }'

{  "id": "string",  "name": "string",  "event": "string",  "window": "none",  "filter": null,  "status": "backfilling",  "backfill": {    "cutoff": "string",    "pending_events": 0  },  "created_at": "string"}

One definition with backfill status

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/counter_definitions/string"

{  "id": "string",  "name": "string",  "event": "string",  "window": "none",  "filter": null,  "status": "backfilling",  "backfill": {    "cutoff": "string",    "pending_events": 0  },  "created_at": "string"}

Delete a definition and its counts (refused while rules read it)

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/counter_definitions/string"

Empty

Count history: inline for small histories, queued for the job otherwise

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/counter_definitions/string/backfill"

{  "status": "ready",  "mode": "inline",  "result": null}

Counts per window for one customer

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

customer_id*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/counter_definitions/string/customers/string"

{  "counter": "string",  "customer_id": "string",  "windows": [    {      "window_key": "string",      "count": 0    }  ]}

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

204

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

202application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`