partnerStatistics

Requires at least one of the permissions customers:customer:read or suppliers:supplier:read.

Returns summary counts of the organization's partners: all, active, customers, vendors, suppliers and recently added. Needs the customers read or suppliers read permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PartnerStatistics {
  partnerStatistics {
    active
    customers
    recent
    suppliers
    total
    vendors
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PartnerStatistics {\n  partnerStatistics {\n    active\n    customers\n    recent\n    suppliers\n    total\n    vendors\n  }\n}"
}
EOF

Response:

{
  "data": {
    "partnerStatistics": {
      "active": 0,
      "customers": 0,
      "recent": 0,
      "suppliers": 0,
      "total": 0,
      "vendors": 0
    }
  }
}

partnerStatistics: PartnerStatistics!

Type

PartnerStatistics object

Headline partner counts.