API Reference Developer Guides

API Reference Developer Guides

- Getting Started
Customer Data API
Transaction Data API

Customer Data API Helper

Organization status check

GET

GET

1 curl https://api.cable.tech/status \
2      -H "x-api-key: <apiKey>"

200Retrieved

1 {
2   "perEndpoint": {
3     "key": {
4       "successes": {
5         "lastWeekCount": 1.1,
6         "lastMonthCount": 1.1
7       },
8       "failures": {
9         "lastWeekCount": 1.1,
10         "lastMonthCount": 1.1,
11         "lastWeekErrors": [
12           {
13             "key": "value"
14           }
15         ]
16       }
17     }
18   },
19   "overall": {
20     "successes": {
21       "lastWeekCount": 1.1,
22       "lastMonthCount": 1.1
23     },
24     "failures": {
25       "lastWeekCount": 1.1,
26       "lastMonthCount": 1.1
27     }
28   }
29 }

Endpoint for organization status check purposes

Headers

x-api-keystringRequired

x-internal-api-keystringRequired

Response

Organization status check

perEndpointmap from strings to objects

overallobjectOptional

Was this page helpful?

Transaction Data API