Query reporting metrics - Orq.ai Documentation

POST

reporting

Query reporting metrics

curl --request POST \
  --url https://api.orq.ai/v2/reporting \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "group_by": [],
  "filters": [
    {
      "values": [
        "<string>"
      ]
    }
  ],
  "limit": 123,
  "time_zone": "<string>",
  "include_totals": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: '2023-11-07T05:31:56Z',
    to: '2023-11-07T05:31:56Z',
    group_by: [],
    filters: [{values: ['<string>']}],
    limit: 123,
    time_zone: '<string>',
    include_totals: true
  })
};

fetch('https://api.orq.ai/v2/reporting', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orq.ai/v2/reporting"

payload = {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "group_by": [],
    "filters": [{ "values": ["<string>"] }],
    "limit": 123,
    "time_zone": "<string>",
    "include_totals": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "object": "report",
  "request": {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "group_by": [],
    "filters": [
      {
        "values": [
          "<string>"
        ]
      }
    ],
    "limit": 123,
    "time_zone": "<string>",
    "include_totals": true
  },
  "data": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "dimensions": {},
      "metrics": {}
    }
  ],
  "totals": {
    "metrics": {}
  },
  "has_more": true,
  "meta": {
    "row_count": 123,
    "request_id": "<string>",
    "currency": "USD",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

metric

enum<string>

required

Catalogue metric to query.

Available options:

genai.requests,

genai.tokens,

genai.cost,

genai.errors,

genai.latency.p50,

genai.latency.p95,

genai.latency.p99,

genai.evaluator.runs,

genai.evaluator.pass_rate,

genai.evaluator.score.avg,

genai.guardrail.runs,

genai.guardrail.block_rate,

genai.guardrail.triggered,

genai.usage

from

string<date-time>

required

Inclusive lower bound for the report window (RFC 3339, UTC).

string<date-time>

required

Exclusive upper bound for the report window (RFC 3339, UTC).

grain

enum<string>

Requested bucket grain. Use auto or omit the field to let the server choose based on the requested range.

Available options:

auto,

minute,

hour,

day

group_by

enum<string>[]

Reporting dimensions to break down by. Valid dimensions depend on the selected metric.

Available options:

project,

identity,

provider,

model,

product,

api_key,

status_code,

http_status_code,

credential_type,

dimension,

dimension_type,

tag,

agent,

tool,

deployment,

evaluator,

dataset,

prompt,

policy,

conversation,

thread,

memory_store,

knowledge,

sheet,

guardrail_origin,

evaluator_name,

evaluator_type,

evaluator_version,

result_type,

evaluation_stage,

guardrail_stage,

evaluator_stage,

guardrail_action,

result_label

filters

object[]

Up to 20 allowlisted predicates combined with AND.

Show child attributes

limit

integer<int32>

Maximum bucket rows returned. Defaults to 1000 and is capped at 5000.

time_zone

string

IANA time zone applied to bucket boundaries, for example America/New_York. Response timestamps remain UTC. Empty means UTC.

include_totals

boolean

When true, include a totals block aggregated across the full report window.

Response

200 - application/json

object

enum<string>

Object discriminator for typed SDKs and JSON parsers; always report.

Available options:

report

request

object

The request that produced this response, parroted back so caller code never has to remember its own payload to interpret the result.

Show child attributes

data

object[]

Time-ordered buckets.

Show child attributes

totals

object

Totals across the whole window. Present only when include_totals=true on the request.

Show child attributes

has_more

boolean

Pagination contract. Always populated; currently false because the server caps the response at limit instead of issuing cursors.

meta

object

Diagnostic metadata.

Show child attributes

Retrieve a prompt version

List guardrail rules

⌘I

Query reporting metrics

curl --request POST \
  --url https://api.orq.ai/v2/reporting \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "group_by": [],
  "filters": [
    {
      "values": [
        "<string>"
      ]
    }
  ],
  "limit": 123,
  "time_zone": "<string>",
  "include_totals": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: '2023-11-07T05:31:56Z',
    to: '2023-11-07T05:31:56Z',
    group_by: [],
    filters: [{values: ['<string>']}],
    limit: 123,
    time_zone: '<string>',
    include_totals: true
  })
};

fetch('https://api.orq.ai/v2/reporting', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orq.ai/v2/reporting"

payload = {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "group_by": [],
    "filters": [{ "values": ["<string>"] }],
    "limit": 123,
    "time_zone": "<string>",
    "include_totals": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "object": "report",
  "request": {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "group_by": [],
    "filters": [
      {
        "values": [
          "<string>"
        ]
      }
    ],
    "limit": 123,
    "time_zone": "<string>",
    "include_totals": true
  },
  "data": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "dimensions": {},
      "metrics": {}
    }
  ],
  "totals": {
    "metrics": {}
  },
  "has_more": true,
  "meta": {
    "row_count": 123,
    "request_id": "<string>",
    "currency": "USD",
    "warnings": [
      "<string>"
    ]
  }
}