Analysis groups

Get analysis group

Returns the full definition of a single analysis group identified by analysis_group_id, including all of its data_collections (each with name, type, description, and constraints). Use this to inspect a group before updating it or to verify exactly what data is extracted/evaluated after a call.

GET

https://api.nabrah.ai/api/ext/analysis/{analysis_group_id}

Get analysis group

curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/analysis/<analysis_group_id>' \
  --header 'X-API-Key: <your-api-key>'

{
  "name": "string",
  "id": "00000000-0000-4000-8000-000000000000",
  "project_id": "00000000-0000-4000-8000-000000000000",
  "created_at": "2026-01-15T12:00:00.000Z",
  "updated_at": "2026-01-15T12:00:00.000Z",
  "data_collections": [
    {
      "name": "string",
      "type": "string",
      "id": "00000000-0000-4000-8000-000000000000",
      "analysis_group_id": "00000000-0000-4000-8000-000000000000",
      "description": "string",
      "constraints": {}
    }
  ]
}

Where analysis_group_id comes from

Discovering the ID

List groups with GET /api/ext/analysis, or use the id returned by POST /api/ext/analysis.

Response shape

Returns a full AnalysisGroupResponse.

Data collections

Each entry in data_collections includes its own id and the parent analysis_group_id, plus the name, type, description, and constraints that drive extraction/evaluation.

nameidproject_idcreated_atupdated_atdata_collections

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Path parameters

analysis_group_idstringrequired

UUID of the analysis group to retrieve.

Get this from GET /api/ext/analysis or from the create response (POST /api/ext/analysis).

Response

200

Successful Response

application/json

422

Validation Error

application/json