Accessing job history
All job events are tracked. Events of a job are processed serially, one by one.
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/jobs/f93f9291-7823-4092-b5db-ed5eb26d4e75/history | jq
{
"events": [
{
"version": 1,
"uuid": "5156e476-3fec-4a82-b843-4cf1ced0fa60",
"type": "job_created",
"payload": { ... },
"context": {
"source": "api",
"happened_at": "2020-06-01T07:17:28.225+00:00",
"created_at": "2020-06-01T07:17:28.843+00:00",
"user_uuid": null,
"user_email": null,
"device_uuid": null
},
},
... // next versions, 2 to 20
]
}
Events are ordered from oldest to newest, in chunks of 20. Every event is linked to one version. To fetch next events, pass after
parameter with version number:
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/jobs/f93f9291-7823-4092-b5db-ed5eb26d4e75/history?after=20 | jq
{
"events": [
... // versions 21 to 40
]
}
Field | Type | JSON type | Can be null |
Description |
---|---|---|---|---|
|
Integer |
Number |
No |
Each event linked to exactly one version |
|
UUID |
String |
No |
Unique event identifier |
|
String |
String |
No |
Event type |
|
Map |
Object |
No |
Context of the event |
|
Map |
Object |
No |
Event payload |
Format of payload is defined by type value. List of event types is open, new types can be added at any time.
|