List report templates

GET/v1/report-templates

Returns every report template the API key's user can see, sorted by name, with no paging. Use a template's reportTemplateId to create a report or a report schedule.

A template's contextTypeId says what a report made from it can cover, and so the shape of the context you send with it: website for one website or section, websites for several. See Context.

A template's own context is not copied into reports made from it. Send the context you want each time.

Skip templates whose isDisabled is true: a live report made from one cannot be read.

Request

curl "https://api.eu.silktide.com/v1/report-templates" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: A built-in template and a custom one

{
  "reportTemplates": [
    {
      "reportTemplateId": "broken-links",
      "name": "Broken links",
      "description": "Summary of broken links for a specific website or section.",
      "rows": [
        {
          "columns": 1
        },
        {
          "columns": 1
        }
      ],
      "created": 1790216527,
      "creatorAssigneeId": "system",
      "contextTypeId": "website",
      "context": [],
      "isCustom": false,
      "isDisabled": false
    },
    {
      "reportTemplateId": "accessibility-22",
      "name": "WCAG 2.2 summary",
      "description": "Summarize WCAG 2.2 standards for a specific website or section.",
      "rows": [
        {
          "columns": 1
        },
        {
          "columns": 4
        },
        {
          "columns": 1
        },
        {
          "columns": 5
        }
      ],
      "created": 1704913002,
      "creatorAssigneeId": "u:eu-12",
      "contextTypeId": "website",
      "context": {
        "websiteId": 3,
        "sectionId": 0
      },
      "isCustom": true,
      "isDisabled": false
    }
  ]
}

Request

No parameters.

Response

200JSON.

reportTemplateslist of objectsrequired
Every report template the API key's user can see, built-in and custom, by name.
Show 10 fieldsHide fields
- reportTemplateIdstringrequired1 to 16 characters
  The template's id, such as broken-links.
- namestringrequiredat least 1 characters
  Its name, as Silktide shows it.
- descriptionstringrequiredup to 255 characters
  What it is for, as Silktide shows it. Can be empty.
- rowslist of objectsrequired
  Its layout, one entry per row of widgets, top to bottom.
  Show 1 fieldsHide fields
  - columnsintegerrequiredat least 1
    How many widgets sit side by side in this row.
- 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.
- contextTypeIdstringrequired
  What kind of thing a report made from it covers: website, websites, account or property.
  One ofwebsitewebsitesaccountproperty
- contextobject or map of any JSON or empty listrequired
  The context its author built it with in Silktide. Reports made from it do not take it: send each report's own context. [] when it has none.
  Show 2 fieldsHide fields
  - websiteIdintegerrequiredat least 1
    The website.
  - sectionIdintegerrequired
    One of its sections. 0 for the whole website.
- isCustombooleanrequired
  true if someone in the account made it, false if it comes with Silktide.
- isDisabledbooleanrequired
  true when Silktide has switched it off. Live reports made from it cannot be read until it is switched back on.

Errors

Status	Type	When
403	`EditionNotAvailable`	The 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.
401	`NotLoggedIn`	No API key was sent, or it is not a key for this region.(any operation)
429	`TooManyRequests`	Too 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.

Request

curl "https://api.eu.silktide.com/v1/report-templates" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: A built-in template and a custom one

{
  "reportTemplates": [
    {
      "reportTemplateId": "broken-links",
      "name": "Broken links",
      "description": "Summary of broken links for a specific website or section.",
      "rows": [
        {
          "columns": 1
        },
        {
          "columns": 1
        }
      ],
      "created": 1790216527,
      "creatorAssigneeId": "system",
      "contextTypeId": "website",
      "context": [],
      "isCustom": false,
      "isDisabled": false
    },
    {
      "reportTemplateId": "accessibility-22",
      "name": "WCAG 2.2 summary",
      "description": "Summarize WCAG 2.2 standards for a specific website or section.",
      "rows": [
        {
          "columns": 1
        },
        {
          "columns": 4
        },
        {
          "columns": 1
        },
        {
          "columns": 5
        }
      ],
      "created": 1704913002,
      "creatorAssigneeId": "u:eu-12",
      "contextTypeId": "website",
      "context": {
        "websiteId": 3,
        "sectionId": 0
      },
      "isCustom": true,
      "isDisabled": false
    }
  ]
}

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.