dashboard

Account metrics of the organization

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.

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)

Path parameters

id_organizationstring required

Organization identifier

Query parameters

from_datestring date-time

Start of the range, ISO 8601. Defaults to 30 days before to_date. A range longer than 366 days answers error 1003.

to_datestring date-time

End of the range, ISO 8601. Defaults to now.

group_by'day' | 'network' | 'account' | 'total'

The axis of the answer. day for a series, network or account for a breakdown, total for one number per metric.

namesDashboardMetricName[]

Only these metrics. Repeat the parameter for several. An unknown name answers error 1000 with the list of valid ones.

Response

Metrics

group_by'day' | 'network' | 'account' | 'total' required

The axis that was applied. Defaults to day; anything else is rejected with 1000.

Changes

No recorded changes to this operation across all 1 revision of this API.