Atoka API User Reference
Timeline Event Root Fields
API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!
Available fields | Description | Data | Used by filters | Facet | Match | Stats |
|---|---|---|---|---|---|---|
| endDate | The event end date | date | - | |||
| eventType | The type of the event | - | eventTypes | |||
| id | Unique ID that you can use throughout the API endpoints to reference to a specific timeline event | "string" | ids | |||
| startDate | The event start date | date | startDateFrom startDateTo | |||
| subjects[] | The entity considered to be the subject of the event | - | - | |||
| subjects[].entityType | the type of the entity the event is about | "string" | - | |||
| subjects[].id | the unique entity ID this event is about | "string" | companies | |||
| subjects[].label | the label representing the entity at the time of creation of the event | "string" | - |
Example JSON fragment for package
{"id": "foo", "subjects": [{"id": "foo", "entityType": "foo", "label": "foo" },...],"eventType": "cebi-micro-score", "startDate": "2015-12-24", "endDate": "2015-12-24" }