Search Console query filters
`/search-query-filters`
One page of records, newest first unless you say otherwise, with the total count in meta so you know how far to paginate.
Required scope: search-query-filters:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
page?integer1-based. meta.totalPages says how many there are.
1 <= value1per_page?integerRows per page. A value above 200 returns 400 - never a silent clamp.
1 <= value <= 20050sort?stringPrefix with - for descending. An undeclared sort returns 400.
"name""name""-name""createdAt""-createdAt""updatedAt""-updatedAt"q?stringCase-insensitive "contains", across: name.
filter[clientId]?stringExact match on clientId.
filter[mode]?stringExact match on mode.
filter[portalDefault]?stringExact match on portalDefault.
"true""false"The requested page.
application/json- response
data*array<>meta*curl -X GET 'https://api.usedashly.com/v1/search-query-filters'{ "data": [ { "id": "string", "clientId": "string", "name": "string", "mode": "string", "rules": null, "portalDefault": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "perPage": 0, "total": 0, "totalPages": 0 }}Links are given as the target's public id (clientId: "hsbftmp3f5"); the API resolves them server-side. Fields the database requires but the interface decides for you are filled in the same way here.
Required scope: search-query-filters:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
name*string1 <= length <= 80mode?string"include""exclude"rules*array<>1 <= items <= 100portalDefault?booleanclientId*stringcreatedAt?stringWhen this actually happened, for an import. Past dates only; defaults to now. updatedAt follows it unless the body sets one.
date-timeCreated. The body is the new record, as a read would return it.
application/json- response
data*curl -X POST 'https://api.usedashly.com/v1/search-query-filters' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "rules": [ { "type": "exact", "value": "string" } ], "clientId": "string"}'{ "data": { "id": "string", "clientId": "string", "name": "string", "mode": "string", "rules": null, "portalDefault": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}The full record, custom fields included when the resource carries them. A record from another agency is a 404, not a 403 - its existence is not ours to confirm.
Required scope: search-query-filters:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
Found.
application/json- response
data*curl -X GET 'https://api.usedashly.com/v1/search-query-filters/string'{ "data": { "id": "string", "clientId": "string", "name": "string", "mode": "string", "rules": null, "portalDefault": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}A partial update: only the fields you send change. One exception - customFields is replaced wholesale, not merged, so sending it with a single key clears the others. Read the record, merge, then write.
Required scope: search-query-filters:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
application/json- body
name?string1 <= length <= 80mode?string"include""exclude"rules?array<>1 <= items <= 100portalDefault?booleanUpdated. The body is the record as it now stands.
application/json- response
data*curl -X PATCH 'https://api.usedashly.com/v1/search-query-filters/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "id": "string", "clientId": "string", "name": "string", "mode": "string", "rules": null, "portalDefault": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}Permanent. The audit log keeps the trace; the record does not come back.
Required scope: search-query-filters:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
Deleted. Empty body.
curl -X DELETE 'https://api.usedashly.com/v1/search-query-filters/string'Every verb this resource answers to, with its target and the JSON Schema of its body - the same contracts this document describes, readable at runtime.
Required scope: search-query-filters:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
The available verbs.
application/json- response
data*array<>curl -X GET 'https://api.usedashly.com/v1/search-query-filters/actions'{ "data": [ { "name": "string", "label": "string", "description": "string", "target": "item", "readOnly": true, "path": "string", "input": {} } ]}The client's Search Console figures over the queries this filter keeps, for a period - days (28 by default, ending on the last consolidated day) or from/to: totals and previousTotals (clicks, impressions, ctr 0..1, position impression-weighted), the daily series of the kept queries and droppedSeries of the others (brand vs non-brand), and the top 50 kept queries. Summed from the per-query rows, so Google's anonymised queries are not counted.
Reads the same data as the in-app loadFilteredSearchAction - same implementation. Changes nothing; also answers GET with the same fields as query parameters.
Required scope: search-query-filters:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
days?integer2 <= value <= 365from?string^\d{4}-\d{2}-\d{2}$to?string^\d{4}-\d{2}-\d{2}$The figures.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X GET 'https://api.usedashly.com/v1/search-query-filters/string/actions/apply'{ "data": null}The client's Search Console figures over the queries this filter keeps, for a period - days (28 by default, ending on the last consolidated day) or from/to: totals and previousTotals (clicks, impressions, ctr 0..1, position impression-weighted), the daily series of the kept queries and droppedSeries of the others (brand vs non-brand), and the top 50 kept queries. Summed from the per-query rows, so Google's anonymised queries are not counted.
Reads the same data as the in-app loadFilteredSearchAction - same implementation. Changes nothing; also answers GET with the same fields as query parameters.
Required scope: search-query-filters:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
days?integer2 <= value <= 365from?string^\d{4}-\d{2}-\d{2}$to?string^\d{4}-\d{2}-\d{2}$Done.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/search-query-filters/string/actions/apply' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": null}Appends one rule {type: exact|contains|starts_with|ends_with|regex, value} to the filter, unless an equal one (case aside) is already there. A regex is at most 200 characters, without back-references, lookbehind, named groups or nested unbounded repetition. A filter holds at most 100 rules. Returns the filter.
Does what the dashboard's addQueryToFilterAction does - same implementation, so the two cannot diverge.
Required scope: search-query-filters:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
type*string"exact""contains""starts_with""ends_with""regex"value*string1 <= length <= 200Done.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/search-query-filters/string/actions/add-rule' \ -H 'Content-Type: application/json' \ -d '{ "type": "exact", "value": "string"}'{ "data": null}What rules would match among the client's Search Console queries over a period, before saving them: how many distinct queries match out of all, their clicks out of all clicks, and the 20 matched queries with the most clicks. Saves nothing.
Reads the same data as the in-app previewQueryFilterAction - same implementation. Changes nothing; also answers GET with the same fields as query parameters.
Required scope: search-query-filters:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
clientId?string1 <= lengthrules?array<>1 <= items <= 100days?integer2 <= value <= 365from?string^\d{4}-\d{2}-\d{2}$to?string^\d{4}-\d{2}-\d{2}$The figures.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X GET 'https://api.usedashly.com/v1/search-query-filters/actions/preview'{ "data": null}What rules would match among the client's Search Console queries over a period, before saving them: how many distinct queries match out of all, their clicks out of all clicks, and the 20 matched queries with the most clicks. Saves nothing.
Reads the same data as the in-app previewQueryFilterAction - same implementation. Changes nothing; also answers GET with the same fields as query parameters.
Required scope: search-query-filters:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
clientId*string1 <= lengthrules*array<>1 <= items <= 100days?integer2 <= value <= 365from?string^\d{4}-\d{2}-\d{2}$to?string^\d{4}-\d{2}-\d{2}$Done.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/search-query-filters/actions/preview' \ -H 'Content-Type: application/json' \ -d '{ "clientId": "string", "rules": [ { "type": "exact", "value": "string" } ]}'{ "data": null}