Retrieve Workspace daily stats

GET

https://cdn.emnify.net/api/v2/workspace/stats/daily

GET

/api/v2/workspace/stats/daily

$ curl https://cdn.emnify.net/api/v2/workspace/stats/daily \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "days": [
4       {
5         "data_volume": {
6           "cost": 0,
7           "currency": null,
8           "rx": 0,
9           "total": 0,
10           "traffic_type": {
11             "description": "Data",
12             "id": 5,
13             "unit": "MB"
14           },
15           "tx": 0
16         },
17         "date": "2024-03-07T00:00:00.000Z",
18         "sms_volume": {
19           "cost": 0,
20           "currency": null,
21           "rx": 0,
22           "total": 0,
23           "traffic_type": {
24             "description": "Sms",
25             "id": 6,
26             "unit": "SMS"
27           },
28           "tx": 0
29         }
30       }
31     ],
32     "id": 123,
33     "total": {
34       "data_volume": {
35         "cost": 0,
36         "rx": 0,
37         "total": 0,
38         "tx": 0
39       },
40       "sms_volume": {
41         "cost": 0,
42         "rx": 0,
43         "total": 0,
44         "tx": 0
45       }
46     }
47   }
48 ]

Organisation.Stats + Get

Roles: Administrator User Observer

Retrieve the daily stats for your Workspaces.

Historical data is available for up to 13 months.

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `Organisation.Stats` + `Get` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info> Retrieve the daily stats for your Workspaces. <Note> Historical data is available for up to **13 months**. </Note>

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Query parameters

start_datestringOptionalformat: "date"

Filters by start date, provided in a YYYY-MM-DD format.

If you don’t define an end date, the response will include 6 months of data, beginning on the current date.

Filters by start date, provided in a `YYYY-MM-DD` format. <Info> If you don't define an end date, the response will include 6 months of data, beginning on the current date. </Info>

end_datestringOptionalformat: "date"

Filters by end date, provided in an YYYY-MM-DD format.

If you don’t define a start date, the response will only return data from the month indicated in your end date.

Filters by end date, provided in an `YYYY-MM-DD` format. <Info> If you don't define a start date, the response will only return data from the month indicated in your end date. </Info>

workspace_idsstringOptionalformat: "(\d+,?)+"

Comma separated list of workspace IDs to filter the results for. If not provided, the response will include all Workspaces you have access to.

Response

Successfully retrieved the daily Workspace stats

iddoubleOptional

dayslist of objectsOptional

totalobject or nullOptional

Errors

403

Forbidden Error

422

Unprocessable Entity Error