Count searches of your site, step by step

GET/v1/results/analytics/site-searches-over-time

Counts searches of your site's own search boxes over the period, one entry per step. Add term for one term, or results as none or some for one outcome. Terms are counted whatever their capitals, so term=Parking and term=parking count the same searches.

Send a period other than all. A series needs a start date, and all, the default, has none: the answer is an error with status 200 and type Error. Check for error before reading result.

How long a step is depends on the period: an hour when it covers a single day, a month for last-12-months, and a day otherwise.

Nothing is recorded until the account lists its search boxes, or describes its search results page, under Analytics > Settings > Data in Silktide; until then every step is 0. results counts only searches whose outcome is known, which needs the search results page described.

To find terms, use Get site search terms. For view, period and filters, see Analytics.

Request

curl "https://api.eu.silktide.com/v1/results/analytics/site-searches-over-time?view=all&period=custom&from=2026-11-01&to=2026-11-03&term=corkscrews&previousPeriod=1" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: Searches for one term over three days, against the three days before

{
  "result": {
    "series": [
      {
        "time": "2026-11-01 00:00:00",
        "searches": 9,
        "previousSearches": 7
      },
      {
        "time": "2026-11-02 00:00:00",
        "searches": 14,
        "previousSearches": 8
      },
      {
        "time": "2026-11-03 00:00:00",
        "searches": 11,
        "previousSearches": 12
      }
    ],
    "total": 34,
    "range": {
      "start": "2026-11-01 00:00:00",
      "end": "2026-11-04 00:00:00"
    },
    "previousTotal": 27
  },
  "selector": "/v1/results/analytics/site-searches-over-time",
  "duration": 0.022
}

Request

Query parameters

viewstringmatches ^(all|[1-9]\d*)$
The analytics view to read: its id, the number after /analytics/ in its address in Silktide, or all for all of the account's analytics. Send this or websiteId.
websiteIdintegerat least 1
Instead of view, a website whose analytics to read. The website must have Analytics set up.
sectionIdinteger
With websiteId, a section of the website. Defaults to 0, the whole website.
periodstring
The date range. Defaults to all. The spaced forms (-7 days, month to date) are older names that keep working. custom needs from and to.
One ofalltodaylast-7-dayslast-30-dayslast-90-daysmonth-to-datelast-monthyear-to-datelast-12-monthscustom-7 days-30 days-90 days-1 monthmonth to dateyear to date-12 months
fromstring
With period=custom, the first day, such as 2026-10-01.
tostring
With period=custom, the last day.
timezonestring
The IANA time zone days are read in, such as America/New_York. Defaults to UTC.
filtersmap of strings
Only visits matching every filter, keyed by what is filtered: filters[url]=contains:/blog. Each value is {operator}:{value}, with operator is, not, contains, starts, gt or lt. Keys include url, hostName, entryUrl, exitUrl, event, outgoingUrl, referrer, source, medium, campaign, content, term, countryCode, regionCode, language, deviceType (desktop, tablet or mobile), operatingSystem and browser.
termstring
Only searches for this term, whatever its capitals, such as a term from Get site search terms. Left out, every search.
resultsstring
none for only searches that found nothing, some for only those that found something. Left out, every search.
One ofnonesome
intervalstring
With period=custom, the length of each step: an hour, a day, a week starting on Monday, a month or a year. Ignored with any other period. Left out, steps are hours for a single day, months for exactly twelve months, and days otherwise.
One ofPT1HP1DP7DP1MP1Y
previousPeriodstring
1 to add the figures of the period before, the same length and ending where this one starts, as previous… fields. Left out or 0, none. Needs a period with a start: with all, nothing is added.
One of01

Response

200JSON.

resultobjectrequired
The answer.
Show 4 fieldsHide fields
- serieslist of objectsrequired
  One entry per step, oldest first, with a 0 for a step with none.
  Show 3 fieldsHide fields
  - timestringrequiredmatches ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
    When the step starts, as YYYY-MM-DD HH:MM:SS in the request's timezone.
  - searchesintegerrequired
    How many searches there were in the step.
  - previousSearchesinteger
    With previousPeriod=1, searches in the matching step of the period before.
- totalintegerrequired
  How many searches there were in the period.
- rangeobjectrequired
  The dates the series covers.
  Show 2 fieldsHide fields
  - startstringrequiredmatches ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
    When the first step starts, as YYYY-MM-DD HH:MM:SS in the request's timezone.
  - endstringrequiredmatches ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
    When the range ends, as YYYY-MM-DD HH:MM:SS: midnight after its last day, so the range runs up to but not including it.
- previousTotalinteger
  With previousPeriod=1, total in the period before.
selectorstringrequired
The query that answered, as its path: /v1/results/scores.
durationnumberrequired
Seconds Silktide took to answer.

Errors

Status	Type	When
404	`ModelNotFound`	No view or website with that id exists in the account, or the API key's user cannot see it.
403	`AccessDenied`	The API key's user cannot read that analytics view.
200	`ModelNotFound`	The website has no Analytics set up. The body is an error despite the status.
200	`InvalidRequest`	Neither `view` nor `websiteId` was sent. The error's own `status` is `400` and `properties.field` is `view`. The body is an error despite the status.
200	`InvalidArgument`	A filter names a key or operator Analytics does not know. The body is an error despite the status.
200	`Error`	`period` is `all` or left out, which means `all`. Over-time queries need a period with a start. The body is an error despite the status.
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: View analytics view (View all analytics for `view=all`)
Plan feature: None
Edition: Silktide 4 and Silktide 5
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/results/analytics/site-searches-over-time?view=all&period=custom&from=2026-11-01&to=2026-11-03&term=corkscrews&previousPeriod=1" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: Searches for one term over three days, against the three days before

{
  "result": {
    "series": [
      {
        "time": "2026-11-01 00:00:00",
        "searches": 9,
        "previousSearches": 7
      },
      {
        "time": "2026-11-02 00:00:00",
        "searches": 14,
        "previousSearches": 8
      },
      {
        "time": "2026-11-03 00:00:00",
        "searches": 11,
        "previousSearches": 12
      }
    ],
    "total": 34,
    "range": {
      "start": "2026-11-01 00:00:00",
      "end": "2026-11-04 00:00:00"
    },
    "previousTotal": 27
  },
  "selector": "/v1/results/analytics/site-searches-over-time",
  "duration": 0.022
}

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.