---
title: "Retrieve component statistics"
method: GET
path: "/components"
tags: ["dashboard"]
---

# Retrieve component statistics

`GET /components`

This will return a JSON object showing individual component statistics across the designated time period.

## Query parameters

- `interval` string, required
- `from` string
- `until` string
- `timeframe` string

## Response `200`

An object containing a list of component stat objects

- object
  - `data` ComponentData[]
    - `componentId` string
    - `componentName` string
    - `status` 'active' | 'inactive' | 'starting' | 'stopping'
    - `statusChangedAt` string
    - `usage` string[]
    - `errorCount` number
    - `bucketStartAt` string
  - `meta` Meta
    - `page` integer — Current page (1-based numbering)
    - `perPage` integer — Number of objects per page
    - `total` integer — Total number of objects
    - `totalPages` integer — Total number of pages

## Other responses

- `500` — Something went wrong

## Changes

- **2022-07-20** `0b81d657d141` — 1 info
  - added the media type `application/json` for the response with the status `200`
- **2022-07-20** `1b61d2ef773b` — 1 info
  - added the new optional `query` request parameter `timeframe`
- **2022-07-01** `71175df6a50c` — 1 info
  - the endpoint scheme security `Bearer` was added to the API
- **2022-06-30** `4fe1a8bfac87` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/openintegrationhub/apis/analytics-service/changes/components/get.md)

---

[API](https://skmtc.dev/openintegrationhub/apis/analytics-service.md) · [All operations](https://skmtc.dev/openintegrationhub/apis/analytics-service/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openintegrationhub/analytics-service/revisions/0b81d657d141/schema)