Dash includes a number of reports, but sometimes you may want to run reports that aren't available within Dash. You can do this using our API. Ideally, this would be done by someone with technical/development experience but this isn't always essential, depending on the query you'd like to run.
How do I run custom download reports?
You can find a link to our API documentation in this article.
Here is the specific page for reporting on assets.
The API documentation itself contains interactive elements that you can use to run queries yourself and get results immediately. If you are a developer, or have access to a developer, this documentation should provide everything you need to create the desired reports.
Example - reporting on downloads from portals
Let's say you would like to report on the number of downloads in the previous month from your portals. Here is how you do it:
Go to this page in the API documentation
Click "Try it"
In the 'Body' section on the right-hand side, paste in the following text:
{
"from": 0,
"pageSize": 0,
"criterion": {
"type": "FIELD_IN_RANGE",
"field": "DATE_TIME",
"from": "2023-10-01T00:00:00.000",
"to": "2023-10-31T23:59:59.999"
},
"sorts": [],
"aggregations": {
"by_portal": {
"type": "TERMS",
"field": "PORTAL_ID"
}
}
}Modify the dates in the "from" and "to" rows to match the date range you would like to report on
Click the "Auth" tab
Paste the access token you obtained earlier into the "Bearer token" field
Click "Send"
In the results, click "Expand all"
You will see a row for each portal, including the number of downloads in the date range you specified. (This lists each portal by its ID - use the PortalSearch operation to obtain the corresponding names of portals).