Skip to main content

Analysis events

Maps to: POST /v1/analyses/events, GET /v1/analyses/events/{uuid}

Events are real-world occurrences (campaigns, news, launches) that you can overlay on an analysis as annotations — useful for explaining movements in a series.

Events for an analysis definition​

POST /v1/analyses/events

Send an analysis definition (the same envelope you would execute); the response lists the events relevant to that analysis — for example, events falling within its brands, sectors and date ranges.

Events for a saved analysis​

GET /v1/analyses/events/{uuid}

Returns the events relevant to a saved analysis, by its UUID.

Using events​

Each event carries a date (and scope), so you can align it to the date coordinate of your result cube and render it as a marker on a chart.

The standalone Events catalogue lets you browse and retrieve events independently of any analysis.