List named filters
List named filters
The Coveo Usage Analytics (Coveo UA) Read API filters/reporting
endpoint allows you to retrieve the list of named filters in your Coveo organization (see /v15/filters/reporting
).
Make sure that you’re using an access token with Analytics - Named filters - View privilege in the target organization (see Create an API key).
|
Note
You’ll usually find it simpler to manage filters through the Coveo Administration Console. This article is only relevant if you have a legitimate reason for listing filters programmatically. |
Example
GET https://analytics.cloud.coveo.com/rest/ua/v15/filters/reporting?org=myOrg HTTP/1.1
Authorization: Bearer **********-****-****-****-************
200 OK response body (excerpt)
{
"filters": [
...
{
"id": "EXCLUDE_PAGEVIEW_BOTS",
"displayName": "Exclude pageView bots",
"account": "myAccount",
"type": "REPORTING",
"value": "(custom_events.c_pageuseragent!@'aolbuild' AND custom_events.c_pageuseragent!@'baidu' AND custom_events.c_pageuseragent!@'bingbot' AND custom_events.c_pageuseragent!@'bingpreview' AND custom_events.c_pageuseragent!@'BaiduSpider' AND custom_events.c_pageuseragent!@'Coveobot' AND custom_events.c_pageuseragent!@'Duckduckgo' AND custom_events.c_pageuseragent!@'msnbot' AND custom_events.c_pageuseragent!@'adsbot-google' AND custom_events.c_pageuseragent!@'googlebot' AND custom_events.c_pageuseragent!@'mediapartners-google' AND custom_events.c_pageuseragent!@'teoma' AND custom_events.c_pageuseragent!@'slurp' AND custom_events.c_pageuseragent!@'yandex' AND custom_events.c_pageuseragent!@'WormlyBot' AND custom_events.c_pageuseragent!@'SMTBot' AND custom_events.c_pageuseragent!@'DuckDuckBot' AND custom_events.c_pageuseragent!@'JobboerseBot' AND custom_events.c_pageuseragent!@'mappydata.net/bot' AND custom_events.c_pageuseragent!@'Refindbot')"
},
...
]
}