Aeonav
Sign up

List rank snapshots

GET
/research/projects/{researchProjectId}/keywords/{researchKeywordId}/rank-snapshots

Measured ranking snapshots for one saved keyword, newest first. Project, keyword, and calling organization must agree. Requires the read scope.

Authorization

BearerAuth read
headerAuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

Scope: read

Path Parameters

researchProjectId*string
Formatuuid
researchKeywordId*string
Formatuuid

Query Parameters

page?integer

Page number, 1-based.

Range1 <= value
Default1
limit?integer

Items per page. Values above the maximum are clamped, not rejected.

Range1 <= value <= 100
Default20

Response Body

Paginated rank snapshots

application/json
  1. response
project*
keyword*
data*array<>
pagination*
Example Request
curl -X GET 'https://app.aeonav.fivecoder.com/api/v1/research/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/keywords/497f6eca-6276-4993-bfeb-53cbbbba6f08/rank-snapshots'
Example Response
{
  "project": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organizationId": "string",
    "name": "string",
    "description": "string",
    "targetDomain": "string",
    "brandId": "string",
    "status": "active",
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "keyword": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "researchProjectId": "1c0d094f-324a-4644-8fb4-5a5c02f86ba0",
    "keyword": "string",
    "targetDomain": "string",
    "locationCode": 0,
    "languageCode": "string",
    "device": "desktop",
    "metrics": {},
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "researchProjectId": "1c0d094f-324a-4644-8fb4-5a5c02f86ba0",
      "researchKeywordId": "dd7cb75e-c45d-4db5-8a94-018136516c7b",
      "keyword": "string",
      "targetDomain": "string",
      "locationCode": 0,
      "languageCode": "string",
      "device": "desktop",
      "position": 0,
      "url": "string",
      "results": [
        null
      ],
      "outcome": "ranked",
      "partial": true,
      "provider": "string",
      "checkedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}