Get several results in one request

Runs several results queries in one request, such as a website's scores, the trend of one score, its checks and one check in detail. The answer is the same as calling each one on its own.

Where each argument goes#

The website goes at the top level, once: websiteId and sectionId (or view, for Analytics) apply to every query. Everything else a query takes, including period, goes in that query's options. A period at the top level is ignored, and so is a websiteId inside options.

Use the argument names on each query's own page. Older documentation sent score to the score trend; the name is scoreId, and without it that entry fails.

One failure does not stop the rest#

The request answers 200 even when some of its queries fail. A query that fails, because an option is missing or wrong, the query name is unknown, or no website was sent, has an error in place of result, and the others still answer. Check each entry for error before you read its result. Its status is what the query would have answered on its own; some mistakes in your request, such as a missing option, come back as 500 there.

selector is the name you sent, such as score-trend, not the path that a single query returns.

A query for one edition of Silktide, such as the Silktide 4 scores, fails with EditionNotAvailable when the account does not have that edition. The others still answer. See Scores.

Two mistakes fail the whole request: a website the API key cannot see (404), and a results that is missing, empty or not an object (400). An entry in results that is not an object, such as a bare query name, fails on its own with InvalidRequest.

curl -X POST "https://api.eu.silktide.com/v1/results" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "websiteId": 2,
  "sectionId": 0,
  "results": {
    "overall-trend": {
      "result": "score-trend",
      "options": {
        "scoreId": "overall",
        "period": "last-90-days"
      }
    },
    "accessibility-trend": {
      "result": "score-trend",
      "options": {
        "scoreId": "wcag-22-aa",
        "period": "last-90-days"
      }
    },
    "no-score": {
      "result": "score-trend"
    }
  }
}'

{
  "results": {
    "overall-trend": {
      "result": {
        "scores": [
          {
            "time": 1790216531,
            "score": 71.2
          },
          {
            "time": 1790821331,
            "score": 74.5
          }
        ]
      },
      "selector": "score-trend",
      "duration": 0.004
    },
    "accessibility-trend": {
      "result": {
        "scores": [
          {
            "time": 1790216531,
            "score": 58.9
          },
          {
            "time": 1790821331,
            "score": 63
          }
        ]
      },
      "selector": "score-trend",
      "duration": 0.003
    },
    "no-score": {
      "error": {
        "type": "InvalidArgument",
        "message": "An unspecified error occurred",
        "properties": [],
        "status": 500
      }
    }
  }
}