Retrieve Workspace daily stats | emnify Documentation

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

[
  {
    "id": 123,
    "days": [
      {
        "date": "2024-03-07T00:00:00.000Z",
        "sms_volume": {
          "total": 0,
          "rx": 0,
          "tx": 0,
          "cost": 0,
          "traffic_type": {
            "id": 6,
            "unit": "SMS",
            "description": "Sms"
          },
          "currency": null
        },
        "data_volume": {
          "total": 0,
          "rx": 0,
          "tx": 0,
          "cost": 0,
          "traffic_type": {
            "id": 5,
            "unit": "MB",
            "description": "Data"
          },
          "currency": null
        }
      }
    ],
    "total": {
      "data_volume": {
        "total": 0,
        "rx": 0,
        "tx": 0,
        "cost": 0
      },
      "sms_volume": {
        "total": 0,
        "rx": 0,
        "tx": 0,
        "cost": 0
      }
    }
  }
]

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

[
  {
    "id": 123,
    "days": [
      {
        "date": "2024-03-07T00:00:00.000Z",
        "sms_volume": {
          "total": 0,
          "rx": 0,
          "tx": 0,
          "cost": 0,
          "traffic_type": {
            "id": 6,
            "unit": "SMS",
            "description": "Sms"
          },
          "currency": null
        },
        "data_volume": {
          "total": 0,
          "rx": 0,
          "tx": 0,
          "cost": 0,
          "traffic_type": {
            "id": 5,
            "unit": "MB",
            "description": "Data"
          },
          "currency": null
        }
      }
    ],
    "total": {
      "data_volume": {
        "total": 0,
        "rx": 0,
        "tx": 0,
        "cost": 0
      },
      "sms_volume": {
        "total": 0,
        "rx": 0,
        "tx": 0,
        "cost": 0
      }
    }
  }
]

Retrieve the daily stats for your Workspaces.

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.

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.

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

iddouble

dayslist of objects

totalobject or null

Errors

422

Unprocessable Entity Error

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

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