Skip to content
Menu
SilktideDevelopers

List report schedules

GET/v1/report-schedules
View as Markdown

Returns every report schedule the API key's user can see, with no paging.

Each schedule lists the users and roles it emails as assigneesIds, but not the other email addresses it sends to. For those, and for who may see and admin a schedule, use Get a report schedule, which returns the same users and roles as subscribers.assigneeIds.

assigneesIds and creatorAssigneeId are assignee ids. The snapshots a schedule has made are in List reports, with its reportScheduleId.

A schedule with a non-null skipped did not run when it was last due, and says why. It needs nothing from you: it runs again by itself once the reason has gone.

Request
curl "https://api.eu.silktide.com/v1/report-schedules" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: A monthly broken links report
{
  "reportSchedules": [
    {
      "reportScheduleId": 1,
      "name": "Broken links report for Wine Barrel",
      "reportTemplateId": "broken-links",
      "context": {
        "websiteId": 3,
        "sectionId": 0
      },
      "emailSubject": "Monthly broken links",
      "emailMessage": "Fix these first.",
      "scheduleInterval": "month",
      "schedulePeriod": 1,
      "scheduleFromDate": 1793577600,
      "durationInterval": "day",
      "durationPeriod": 30,
      "created": 1793520000,
      "lastRun": 1796169600,
      "nextDue": 1798761600,
      "creatorAssigneeId": "u:eu-12",
      "assigneesIds": [
        "u:eu-12",
        "g:4"
      ],
      "skipped": null
    }
  ]
}

Request

No parameters.

Response

200JSON.

  • reportScheduleslist of objectsrequired

    Every report schedule the API key's user can see.

    Show 17 fields
    • reportScheduleIdintegerrequiredat least 1

      The report schedule.

    • namestringrequiredat least 1 characters

      Its name. The snapshots it makes are named from their template, not from this.

    • reportTemplateIdstringrequired1 to 16 characters

      The report template each snapshot is built from.

    • 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.

    • emailSubjectstringrequiredup to 255 characters

      The subject of the email subscribers get. Empty for the default, the snapshot's name followed by "is ready".

    • emailMessagestringrequiredup to 4096 characters

      Text at the top of the email subscribers get. Can be empty.

    • scheduleIntervalstringrequired

      The unit of how often it runs.

      One ofdayweekmonthyear

    • schedulePeriodintegerrequired1 to 90

      How many scheduleIntervals apart runs are. week and 2 runs every two weeks.

    • scheduleFromDateintegerrequired

      When the schedule counts from. Each run falls a whole number of periods after it.

    • durationIntervalstringrequired

      The unit of how far back each snapshot looks.

      One ofdayweekmonthyear

    • durationPeriodintegerrequired1 to 90

      How many durationIntervals back each snapshot looks, from when it runs.

    • createdintegerrequired

      When it was created.

    • lastRunintegerrequired

      When it last made a snapshot. 0 if never.

    • nextDueintegerrequired

      When it next runs. In the past when a run is waiting to be picked up.

    • creatorAssigneeIdstringrequired

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

    • skippedobjectrequiredcan be null

      Null, or why its last due run made no snapshot and sent no email. It runs again by itself once the reason has gone.

      Show 3 fields
      • atintegerrequired

        When the run was due.

      • reasonstringrequired

        Why it was skipped, as a stable id: no-platform-access when the account has no active plan.

      • messagestringrequiredcan be null

        The reason, in the API user's language. Null for a reason without one.

    • assigneesIdslist of stringsrequired

      Users and roles emailed when it runs, as assignee ids. Note the spelling: assigneesIds, with an s.

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.