Org dashboard metrics

curl --request GET \
  --url https://prod-api.pcxpay.com/v1/virtual-accounts/org/{org_id}/dashboard/metrics \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'

{
  "data": {}
}

GET

virtual-accounts

org

{org_id}

dashboard

metrics

Org dashboard metrics

curl --request GET \
  --url https://prod-api.pcxpay.com/v1/virtual-accounts/org/{org_id}/dashboard/metrics \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'

{
  "data": {}
}

Headers

Authorization

string

default:NONE

required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

X-Api-Key

string

default:NONE

required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Path Parameters

org_id

string

required

Response

Aggregated account metrics for the organisation

data

object

⌘I