Rank tracking settings
`/rank-settings`
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: rank-settings: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.
"-createdAt""createdAt""-createdAt""updatedAt""-updatedAt""domain""-domain"q?stringCase-insensitive "contains", across: domain.
filter[clientId]?stringExact match on clientId.
filter[enabled]?stringExact match on enabled.
"true""false"filter[frequency]?stringExact match on frequency.
filter[device]?stringExact match on device.
The requested page.
application/json- response
data*array<>meta*curl -X GET 'https://api.usedashly.com/v1/rank-settings'{ "data": [ { "id": "string", "clientId": "string", "domain": "string", "frequency": "string", "device": "string", "locationCode": 0, "languageCode": "string", "maxKeywords": 0, "enabled": true, "activatedAt": "2019-08-24T14:15:22Z", "nextDueAt": "2019-08-24T14:15:22Z", "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: rank-settings: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
domain*stringlength <= 253frequency?string"weekly""daily"device?string"desktop""mobile"locationCode?integer0 < value <= 9007199254740991languageCode?string2 <= length <= 8maxKeywords?integer1 <= value <= 1000clientId*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/rank-settings' \ -H 'Content-Type: application/json' \ -d '{ "domain": "string", "clientId": "string"}'{ "data": { "id": "string", "clientId": "string", "domain": "string", "frequency": "string", "device": "string", "locationCode": 0, "languageCode": "string", "maxKeywords": 0, "enabled": true, "activatedAt": "2019-08-24T14:15:22Z", "nextDueAt": "2019-08-24T14:15:22Z", "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: rank-settings: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/rank-settings/string'{ "data": { "id": "string", "clientId": "string", "domain": "string", "frequency": "string", "device": "string", "locationCode": 0, "languageCode": "string", "maxKeywords": 0, "enabled": true, "activatedAt": "2019-08-24T14:15:22Z", "nextDueAt": "2019-08-24T14:15:22Z", "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: rank-settings: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
domain?stringlength <= 253frequency?string"weekly""daily"device?string"desktop""mobile"locationCode?integer0 < value <= 9007199254740991languageCode?string2 <= length <= 8maxKeywords?integer1 <= value <= 1000Updated. The body is the record as it now stands.
application/json- response
data*curl -X PATCH 'https://api.usedashly.com/v1/rank-settings/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "id": "string", "clientId": "string", "domain": "string", "frequency": "string", "device": "string", "locationCode": 0, "languageCode": "string", "maxKeywords": 0, "enabled": true, "activatedAt": "2019-08-24T14:15:22Z", "nextDueAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}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: rank-settings: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/rank-settings/actions'{ "data": [ { "name": "string", "label": "string", "description": "string", "target": "item", "readOnly": true, "path": "string", "input": {} } ]}