Skip to content
Menu
SilktideDevelopers

List reports

GET/v1/reports
View as Markdown

Returns every report the API key's user can see, with no paging. It lists live reports (dashboards) and snapshots together; tell them apart by isLive.

Snapshots a report schedule made are here too, with that schedule's reportScheduleId.

context is [], not {}, when a report has no context of its own. Its shape for each contextTypeId is in Context. creatorAssigneeId is an assignee id.

To read what a report shows, use Get a report's results.

Request
curl "https://api.eu.silktide.com/v1/reports" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: A live report and a snapshot
{
  "reports": [
    {
      "reportId": 1,
      "reportTemplateId": "websites",
      "reportScheduleId": 0,
      "contextTypeId": "websites",
      "name": "Websites dashboard",
      "thumbnailUrl": "",
      "startTime": 0,
      "endTime": 0,
      "durationInterval": "day",
      "durationPeriod": 90,
      "created": 1790402302,
      "creatorAssigneeId": "system",
      "context": [],
      "isLive": true,
      "version": 3
    },
    {
      "reportId": 6,
      "reportTemplateId": "spelling",
      "reportScheduleId": 0,
      "contextTypeId": "website",
      "name": "Spelling report for Wine Barrel",
      "thumbnailUrl": "https://example-bucket.s3.amazonaws.com/reports/6/thumb.webp",
      "startTime": 1791643553,
      "endTime": 1794235553,
      "durationInterval": "day",
      "durationPeriod": 30,
      "created": 1794235553,
      "creatorAssigneeId": "u:eu-12",
      "context": {
        "websiteId": 3,
        "sectionId": 0
      },
      "isLive": false,
      "version": 3
    }
  ]
}

Request

No parameters.

Response

200JSON.

  • reportslist of objectsrequired

    Every report the API key's user can see, live reports and snapshots alike.

    Show 15 fields
    • reportIdintegerrequiredat least 1

      The report.

    • reportTemplateIdstringrequired1 to 16 characters

      The report template it is made from.

    • reportScheduleIdintegerrequired

      The report schedule that made it. 0 when it was not made by a schedule.

    • contextTypeIdstringrequired

      What kind of thing it covers, copied from its template: website, websites, account or property.

      One ofwebsitewebsitesaccountproperty

    • namestringrequiredat least 1 characters

      Its name.

    • thumbnailUrlstringrequired

      A small screenshot of it. Empty until one is made, a few minutes after a snapshot is created.

    • startTimeintegerrequired

      For a snapshot, the start of the dates it covers. 0 for a live report.

    • endTimeintegerrequired

      For a snapshot, the end of the dates it covers. 0 for a live report.

    • durationIntervalstringrequired

      The unit of how far back it looks.

      One ofdayweekmonthyear

    • durationPeriodintegerrequired0 to 90

      How many durationIntervals back it looks. week and 4 cover the last four weeks.

    • createdintegerrequired

      When it was created.

    • creatorAssigneeIdstringrequired

      The assignee who created it: a user (u:), an API key (a:), or system for those Silktide made itself.

    • contextobject or map of any JSON or empty listrequired

      What it covers, in the shape its contextTypeId takes: {"websiteId": 3, "sectionId": 0} for one website, {"criteria": {...}} for several. [] when it has none.

      Show 2 fields
      • websiteIdintegerrequiredat least 1

        The website.

      • sectionIdintegerrequired

        One of its sections. 0 for the whole website.

    • isLivebooleanrequired

      true for a live report (a dashboard), which is built afresh each time it is read. false for a snapshot, built once when it is created.

    • versionintegerrequiredat least 1

      The version of the format it is stored in, which Silktide uses to upgrade older reports. Nothing to act on.

Errors

StatusTypeWhen
403EditionNotAvailableThe account does not have Silktide 4. Reports, report schedules and report templates are Silktide 4's, so an account with only Silktide 5 cannot use them.
401NotLoggedInNo API key was sent, or it is not a key for this region.(any operation)
429TooManyRequestsToo many requests to this path in five seconds. Retry after the number of seconds in the Retry-After header, which properties.retryAfter repeats.(any operation)
503-Silktide is busy. Retry after the number of seconds in the Retry-After header.(any operation)

Every error has the same body. See Errors.

Access

Permission
Any user of the account
Plan feature
None
Edition
Silktide 4 only
Cost
Free
Available since
v1.0.0

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.