In order to generate and then download reports from Actimo via API, you will need an API key. If you don't already have one, please reach out to your CSM or Support and we can generate one for you.
Using your API tool, we will first retrieve the relevant workspace ID with a GET call. Once we have our workspace ID, we will make a POST API call to start the report generation, followed by another GET call to poll the request and retrieve the link that allows us to download the report.
Retrieve the Workspace ID
To retrieve the workspace ID, we need to make a simple GET call:
This will show all of your workspaces and their respective IDs. The response will look like the example below:
Generating the Report
Actimo has multiple report types that can be generated. Please see the options below:
As an example for this article, we will look at generating a Pulse Survey Report.
We want to begin by making the following POST call with the JSON:
{
"task_args": {
"workspaceId": 9643,
"interval": {
"from": 1741651200000,
"to": 1741737599000
},
"timezone": "(GMT+01:00) Copenhagen",
"selected_project": 0,
"messageId": 1708871,
"type": "pulse"
},
"task_name": "pulse_message_report",
"task_type": "report"
}Don't forget to swap-in your workspace ID, interval (Unix Epoch format), messageID, task_name & task_type.
It should look something like this in your API tool:
Once sent, our reply should contain a Request ID that we can then use to poll the request for the report generation.
See an example response below:
Download the Report
Now we just need to poll that request ID with a GET call:
**Add your own response ID number at the end**
The response will contain a URL like so:
Take the URL and paste it into a browser without the quotation marks at the beginning and end.
Your report should then download automatically.