Skip to main content
GET
/
api
/
v1
/
analytics
/
weekly-rollup
Weekly rollup snapshot
curl --request GET \
  --url https://app.vorel.ai/api/v1/analytics/weekly-rollup \
  --header 'Authorization: Bearer <token>'
{
  "since": "2023-11-07T05:31:56Z",
  "computed_at": "2023-11-07T05:31:56Z",
  "qa_avg": 123,
  "qa_p50": 123,
  "qa_p95": 123,
  "conversation_count": 1,
  "agent_turn_count": 1,
  "hallucination_flag_count": 1,
  "top_flag_kinds": [
    {
      "kind": "<string>",
      "count": 1
    }
  ],
  "top_handoff_reasons": [
    {
      "kind": "<string>",
      "count": 1
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.vorel.ai/llms.txt

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

Authorizations

​
Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Query Parameters

​
since
string<date-time>

Inclusive lower bound of the rollup window. ISO 8601 timestamp. Defaults to 7 days before the request time. Must be at least 1 hour and at most 90 days in the past.

Response

Rollup snapshot for the requested window.

Single snapshot of the metrics the around-the-brain weekly automation needs. All percentile / average fields are nullable when no source rows exist in the window — render those as "no data" rather than zero.

​
since
string<date-time>
required

Inclusive lower bound of the window.

​
computed_at
string<date-time>
required
​
qa_avg
number | null
required

Mean QA total_score.

​
qa_p50
number | null
required

Median QA total_score.

​
qa_p95
number | null
required

95th percentile QA total_score.

​
conversation_count
integer
required
Required range: x >= 0
​
agent_turn_count
integer
required

messages.role IN (agent_bot, agent_human).

Required range: x >= 0
​
hallucination_flag_count
integer
required

Messages with non-empty hallucination_flags array.

Required range: x >= 0
​
top_flag_kinds
object[]
required
Maximum array length: 5
​
top_handoff_reasons
object[]
required
Maximum array length: 5