Reports
Live reports and snapshots built from report templates, and what they show.
A report is a page of widgets, such as scores, charts and tables, laid out by a report template and pointed at something to cover, its context: one website, a set of websites, or the whole account.
There are two kinds, told apart by isLive:
- Live reports (
isLive: true), which Silktide calls dashboards, are built afresh every time you read them, over a length of time counted back from now. If what they cover is removed, such as a website that is deleted, they can no longer show it. - Snapshots (
isLive: false) are built once, when they are created, over fixed dates, and never change. They keep working when what they cover is removed.
Create a report from a template, then read its results. To make a snapshot on a regular interval and email it to people, use a report schedule.
Each report records who created it, as an assignee, and has its own permissions: who may see it and who may admin it.
- GETList reports
/v1/reportsReturns every report the API key's user can see, with no paging. - GETGet a report
/v1/reports/{reportId}Returns one report, as List reports lists it. - GETGet what a report shows
/v1/reports/{reportId}/resultsReturns what a report shows: the template it is built from, the template's widgets, and each widget's results under its widgetId. - POSTCreate a live report or a snapshot
/v1/reportsCreates a report from a report template, and builds it. - PUTRename a report, or change what a live report covers
/v1/reports/{reportId}Changes a report. - DELDelete a report
/v1/reports/{reportId}Deletes a report and its results at once.