Credit usage timeseries

GET

https://api.smallest.ai/atoms/v1/analytics/usage/timeseries

GET

/atoms/v1/analytics/usage/timeseries

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/analytics/usage/timeseries"
4 
5 querystring = {"dateFrom":"2023-01-01T00:00:00Z","dateTo":"2023-01-15T23:59:59Z"}
6 
7 payload = {}
8 headers = {
9     "Authorization": "Bearer <token>",
10     "Content-Type": "application/json"
11 }
12 
13 response = requests.get(url, json=payload, headers=headers, params=querystring)
14 
15 print(response.json())

1 {
2   "success": true,
3   "data": {
4     "dateRange": {
5       "from": "2023-01-01",
6       "to": "2023-01-15"
7     },
8     "dayWiseCredits": [
9       {
10         "date": "2023-01-01",
11         "credits": 2.5
12       },
13       {
14         "date": "2023-01-02",
15         "credits": 3
16       },
17       {
18         "date": "2023-01-03",
19         "credits": 1.8
20       },
21       {
22         "date": "2023-01-04",
23         "credits": 2.2
24       },
25       {
26         "date": "2023-01-05",
27         "credits": 2.9
28       },
29       {
30         "date": "2023-01-06",
31         "credits": 3.1
32       },
33       {
34         "date": "2023-01-07",
35         "credits": 2.7
36       },
37       {
38         "date": "2023-01-08",
39         "credits": 3.3
40       },
41       {
42         "date": "2023-01-09",
43         "credits": 2.6
44       },
45       {
46         "date": "2023-01-10",
47         "credits": 3
48       },
49       {
50         "date": "2023-01-11",
51         "credits": 2.8
52       },
53       {
54         "date": "2023-01-12",
55         "credits": 3.4
56       },
57       {
58         "date": "2023-01-13",
59         "credits": 2.9
60       },
61       {
62         "date": "2023-01-14",
63         "credits": 3.2
64       },
65       {
66         "date": "2023-01-15",
67         "credits": 3
68       }
69     ],
70     "totalCredits": 42.4
71   }
72 }

Returns daily credit usage over a date range.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

dateFromdatetimeOptional

Start of date range (ISO 8601)

dateTodatetimeOptional

End of date range (ISO 8601)

Response

Daily credit usage

successboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error