latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-1781289731.0 KB

68e1a2c609c0

analytics

Query key verification data

Execute custom SQL queries against your key verification analytics. CTEs, subqueries, UNION, and EXCEPT are supported. Queries must use one of the five public aliases: key_verifications_v1, key_verifications_per_minute_v1, key_verifications_per_hour_v1, key_verifications_per_day_v1, or key_verifications_per_month_v1. Physical default.* table names are unsupported. Queries are always restricted to the authenticated workspace. Wildcard analytics permission can read every API in that workspace; API-scoped permissions automatically restrict results to the permitted APIs. For complete documentation including available tables, columns, data types, query examples, see the schema reference in the API documentation.

post/v2/analytics.getVerifications

Request body

querystring required

SQL query to execute against your analytics data. Queries may reference only the five public aliases: key_verifications_v1, key_verifications_per_minute_v1, key_verifications_per_hour_v1, key_verifications_per_day_v1, or key_verifications_per_month_v1. Physical default.* table names are unsupported. Only SELECT queries are allowed. CTEs, subqueries, UNION, and EXCEPT are supported.

Example request

{
  "query": "SELECT COUNT(*) as total FROM key_verifications_v1 WHERE outcome = 'VALID' AND time >= now() - INTERVAL 7 DAY"
}

Response

Query executed successfully

dataobject[] required

Array of verification rows returned by the query. Fields vary based on the SQL SELECT clause.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "outcome": "VALID",
      "count": 1234,
      "time": 1696118400000
    },
    {
      "outcome": "RATE_LIMITED",
      "count": 56,
      "time": 1696118400000
    }
  ]
}