---
title: "Account metrics of the organization"
method: GET
path: "/organizations/{id_organization}/metrics"
tags: ["dashboard"]
---

# Account metrics of the organization

`GET /organizations/{id_organization}/metrics`

## Request

- Base URL: `https://api.planvortex.com/v1.0.0`
- URL: `https://api.planvortex.com/v1.0.0/organizations/{id_organization}/metrics`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://api.planvortex.com/v1.0.0/oauth/token`)

Account statistics added up across the organization, on the axis asked for in `group_by`.

**Not every metric adds up the same way.** `impressions` over a week is the sum of the seven days, but `followers` is the *last* value of each account: adding up seven snapshots of "1.200 followers" would report 8.400. The aggregation already knows which is which — do not add up the series yourself.

A metric that a network does not publish is simply absent. It is not a zero.

## Path parameters

- `id_organization` string, required

## Query parameters

- `from_date` string, date-time
- `to_date` string, date-time
- `group_by` 'day' | 'network' | 'account' | 'total'
- `names` DashboardMetricName[]

## Response `200`

Metrics

- object
  - `range` DashboardDashboardRange, required: The range that was actually used, plus the previous period of exactly the same length. The previous one is not "last month": comparing 30 days against a calendar month would move the delta with the calendar.
    - `from_date` string, date-time, required
    - `to_date` string, date-time, required
    - `previous_from_date` string, date-time, required
    - `previous_to_date` string, date-time, required
  - `group_by` 'day' | 'network' | 'account' | 'total', required: The axis that was applied. Defaults to `day`; anything else is rejected with 1000.
  - `stats` DashboardMetricRow[], required
    - `group` string, nullable, required: The value of the axis: the day, the network or the account identifier. **`null` when `group_by` was `total`** — the field is always there, the value is not always a string.
    - `name` 'impressions' | 'reach' | 'engagement' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'video_views' | 'profile_views' | 'followers' | 'followers_gained', required: A metric in PlanVortex's common vocabulary. Each network reports what it reports and PlanVortex translates it; a metric a network does not publish is absent, never zero.
    - `value` number, required

## Other responses

- `400`: Error. Classify by `code` in the body, never by the HTTP status.

---

[API](https://skmtc.dev/planvortex/apis/planvortex-api.md) · [All operations](https://skmtc.dev/planvortex/apis/planvortex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/planvortex/apis/planvortex-api/revisions/abedbbc1cd52?raw)