Skip to main content
GET
/
v1
/
analyses
/
{analysis_id}
/
status
Get Analysis Status
curl --request GET \
  --url https://api.example.com/v1/analyses/{analysis_id}/status \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "analysis": {
      "id": "<string>",
      "name": "<string>",
      "owner_id": "<string>",
      "created_at": 123,
      "description": "<string>",
      "started_at": 123
    },
    "overview": {
      "analysis_status": "<string>",
      "percentage": 123,
      "sub_analyses_counts": {
        "total": 123,
        "pending": 123,
        "queued": 123,
        "in_progress": 123,
        "completed": 123,
        "problem": 123,
        "failed": 123,
        "skipped": 123
      }
    },
    "details": {
      "pending": [
        {
          "id": "<string>",
          "url": "<string>",
          "status_message": "<string>"
        }
      ],
      "queued": [
        {
          "id": "<string>",
          "url": "<string>",
          "status_message": "<string>"
        }
      ],
      "in_progress": [
        {
          "id": "<string>",
          "url": "<string>",
          "status_message": "<string>"
        }
      ],
      "completed": [
        {
          "id": "<string>",
          "url": "<string>",
          "status_message": "<string>"
        }
      ],
      "problem": [
        {
          "id": "<string>",
          "url": "<string>",
          "status_message": "<string>"
        }
      ],
      "failed": [
        {
          "id": "<string>",
          "url": "<string>",
          "status_message": "<string>"
        }
      ],
      "skipped": [
        {
          "id": "<string>",
          "url": "<string>",
          "status_message": "<string>"
        }
      ]
    }
  },
  "response_type": "AnalysisStatusResponse",
  "links": []
}

Authorizations

​
X-API-Key
string
header
required

API Key for external integrations (format: greetincs_...)

Path Parameters

​
analysis_id
string
required

Analysis ID in TypeID format

Response

Successful Response

Response for analysis status endpoint.

​
data
AnalysisStatusData · object
required

Analysis status data with new structure.

​
response_type
string
default:AnalysisStatusResponse
​
links
Link · object[]

HATEOAS links related to this response (e.g., self, next, prev)

Example:
[
  {
    "href": "/resource/{resource_id}",
    "method": "GET",
    "rel": "self",
    "title": "Resource Details"
  },
  {
    "href": "/resource/{resource_id}/related",
    "method": "GET",
    "rel": "related",
    "title": "Related Resources"
  }
]