List the pages where people met dead clicks
/v1/results/analytics/frustration-pagesLists the pages where people got stuck. It is the Frustration table in Analytics, and takes the Analytics arguments and the table arguments. search matches the page's address.
The only frustration Silktide detects is the dead click: a click on something that did not respond, such as a heading that looks like a link or an image people expect to open. A page's frustrationScore is its dead clicks per visitor, on average: 0 means none, and 1 is very high.
topElementSelector, topElementText and topElementClicks name what people dead-clicked most on the page, so you can find it and decide whether it should be a link or should stop looking like one.
Rows are sorted by affectedVisitors, most first. The topElement… fields cannot be sorted by: a sort naming one of them answers with an error. Send previousPeriod=1 to compare each page with the period before.
curl "https://api.eu.silktide.com/v1/results/analytics/frustration-pages?view=all&period=last-30-days&rowsPerPage=2" \
-H "Authorization: silktide token=$SILKTIDE_API_KEY"{
"result": {
"page": 1,
"minPage": 1,
"maxPage": 7,
"numRows": 13,
"rowsPerPage": 2,
"rows": [
{
"url": "https://fakewinebarrel.com/",
"visitors": 411,
"affectedVisitors": 41,
"totalFrustration": 58,
"frustrationScore": 0.1411,
"clicks": 445,
"topElementSelector": "body>div>footer>div>div>div:nth-child(1)>div>h3",
"topElementText": "Contact us",
"topElementClicks": 20
},
{
"url": "https://fakewinebarrel.com/wines/",
"visitors": 183,
"affectedVisitors": 17,
"totalFrustration": 24,
"frustrationScore": 0.1311,
"clicks": 206,
"topElementSelector": "main>div.grid>div:nth-child(2)>img",
"topElementText": "",
"topElementClicks": 9
}
]
},
"selector": "/v1/results/analytics/frustration-pages",
"duration": 0.09
}Request
Query parameters
viewstringmatches^(all|[1-9]\d*)$The analytics view to read: its id, the number after
/analytics/in its address in Silktide, orallfor all of the account's analytics. Send this orwebsiteId.websiteIdintegerat least 1Instead of
view, a website whose analytics to read. The website must have Analytics set up.sectionIdintegerWith
websiteId, a section of the website. Defaults to0, the whole website.periodstringThe date range. Defaults to
all. The spaced forms (-7 days,month to date) are older names that keep working.customneedsfromandto.One of
alltodaylast-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 monthsfromstringWith
period=custom, the first day, such as2026-10-01.tostringWith
period=custom, the last day.timezonestringThe IANA time zone days are read in, such as
America/New_York. Defaults toUTC.filtersmap of stringsOnly visits matching every filter, keyed by what is filtered:
filters[url]=contains:/blog. Each value is{operator}:{value}, with operatoris,not,contains,starts,gtorlt. Keys includeurl,hostName,entryUrl,exitUrl,event,outgoingUrl,referrer,source,medium,campaign,content,term,countryCode,regionCode,language,deviceType(desktop,tabletormobile),operatingSystemandbrowser.columnsstringThe columns to return, comma-separated, such as
url,pageViews. Left out, the table's default columns. Send a string even in a JSON body: an array is ignored.sortstringThe column to sort by, then
:afor ascending or:dfor descending, such aspageViews:d. Left out, the table's own order.searchstringOnly rows matching this text. What it searches depends on the table, most often the URL or title.
pageintegerat least 1The page of rows to return, from
1. Defaults to1.rowsPerPageintegerat least 1How many rows a page holds. Defaults to
100.previousPeriodstring1to add the figures of the period before, the same length and ending where this one starts, asprevious…fields. Left out or0, none. Needs aperiodwith a start: withall, nothing is added.One of
01
Response
200JSON.
resultobjectrequiredThe answer.
Show 6 fieldsHide fields
pageintegerrequiredat least 1The page returned. Not always the page asked for, when that was out of range.
minPageintegerrequiredat least 1The first page. Always
1.maxPageintegerrequiredThe last page at this
rowsPerPage. With no rows,0or1depending on the table.numRowsintegerrequiredHow many rows there are across every page.
rowsPerPageintegerrequiredat least 1How many rows a page holds.
rowslist of objectsrequiredThe rows on this page.
Show 12 fieldsHide fields
urlstringrequireduriThe page's address. Filter other queries to it with
filters[url].visitorsintegerrequiredUnique visitors who viewed the page.
affectedVisitorsintegerrequiredVisitors affected: unique visitors who made at least one dead click on it.
totalFrustrationintegerrequiredDead clicks on the page: clicks on something that did not respond.
frustrationScorenumberrequiredcan be nullDead clicks per visitor of the page, on average:
0is none, and1is very high. Null when the page had no visitors.clicksintegerrequiredEvery click on the page, dead or not.
topElementSelectorstringrequiredThe CSS selector of what people dead-clicked most on the page. Empty when nothing was dead-clicked.
topElementTextstringrequiredThe text of that element, as the page showed it. Empty when it had none, or nothing was dead-clicked.
topElementClicksintegerrequiredDead clicks on that element.
0when nothing was dead-clicked.previousTotalFrustrationintegerDead clicks in the period before. Only with
previousPeriod=1and aperiodother thanall.0when it had none then.previousAffectedVisitorsintegerVisitors affected in the period before. Only with
previousPeriod=1and aperiodother thanall.0when it had none then.previousVisitorsintegerUnique visitors in the period before. Only with
previousPeriod=1and aperiodother thanall.0when it had none then.
selectorstringrequiredThe query that answered, as its path:
/v1/results/scores.durationnumberrequiredSeconds 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 | InvalidArgument | period is not one of its values, or is custom without both from and to. The body is an error despite the status. |
| 200 | - | sort names a column the table cannot sort by. Sort by url, visitors, affectedVisitors, totalFrustration, frustrationScore or clicks only. 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.