Skip to main content

Benchmarks

GET/v1/orgs/{org_id}/benchmarks

List Benchmarks

List benchmark runs for an organization.

Bearer token or X-API-Keyscope: org memberoperation_id: benchmarks.list

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. Any org token with sufficient scope. Create tokens from the console or the /v1/orgs/{org_id}/tokens endpoints. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X GET "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/benchmarks?limit=50&offset=0" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

{
  "total": 0,
  "limit": 0,
  "offset": 0,
  "runs": [
    {
      "id": "string",
      "dataset_id": "string",
      "policy_version": null,
      "bundle_id": null,
      "status": "string",
      "total_samples": 0,
      "completed_samples": 0,
      "results_summary": null,
      "started_at": null,
      "completed_at": null,
      "created_at": null,
      "executor": "string",
      "claimed_by": null,
      "error_detail": null
    }
  ]
}

Schema: object

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired-

Query parameters

NameTypeRequiredDescription
dataset_id#querystring | nulloptional-
status#querystring | nulloptional-
limit#queryintegeroptional-
offset#queryintegeroptional-

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional-
authorization#headerstring | nulloptional-

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

totalrequiredinteger
limitrequiredinteger
offsetrequiredinteger
runsrequired

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.-
403Token does not have org access (wrong org_id, or insufficient role).-
404Resource does not exist in this org.-