📋 Get usage summary for a company

Request

Get a high-level usage summary for a company.

Security

APIKeyHeader

Headers

X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:

Sandbox client

client_abc123

curl -i -X GET \
  https://pdp.seqino.dev/api/usage/summary \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-PDP-Client-Id: client_abc123'

Responses

Successful Response

Bodyapplication/json

company_idstring(Company Id)required

current_month_callsinteger, >= 0(Current Month Calls)required

API calls in current month

previous_month_callsinteger, >= 0(Previous Month Calls)required

API calls in previous month

month_over_month_changenumber(Month Over Month Change)required

Percentage change from previous month

most_used_endpointstring or null(Most Used Endpoint)required

Any of:

Most frequently used endpoint

string

least_used_endpointstring or null(Least Used Endpoint)required

Any of:

Least frequently used endpoint

string

peak_usage_daystring or null(Peak Usage Day)required

Any of:

Day with highest usage

string (date)

peak_usage_countinteger or null(Peak Usage Count)required

Any of:

Highest daily usage count

>= 0

integer

Response

{
  "company_id": "string",
  "current_month_calls": 0,
  "previous_month_calls": 0,
  "month_over_month_change": 0,
  "most_used_endpoint": "string",
  "least_used_endpoint": "string",
  "peak_usage_day": "2019-08-24",
  "peak_usage_count": 0
}