keywords

List project keywords

Changed on
get/projects/{project_id}/keywords

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/keywords
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /api/auth/oauth2/authorize, token URL /api/auth/oauth2/token, scopes: api:read)

Path parameters

project_idstring required

Public project ID; membership and token scope are enforced.

Example:prj_a00000000000000000000000

Query parameters

limitinteger

Maximum items to return. Defaults to 50.

cursorstring

Opaque v3 cursor returned as meta.next_cursor from the previous page.

searchstring

Case-insensitive keyword text search. Also accepted as q.

tagstring

Case-insensitive exact tag filter. Also accepted as filter[tag].

topicstring

Case-insensitive exact topic filter. Also accepted as filter[topic].

intentstring

Case-insensitive exact intent filter. Also accepted as filter[intent].

device'desktop' | 'mobile'

Filter by SERP device. Also accepted as filter[device].

location_keystring

Filter by the exact canonical location key, optionally qualified with @language. Also accepted as filter[location_key].

countrystring

Filter by canonical country or stored location alias. Also accepted as filter[country]. Deprecated legacy market input: send location_key instead. Still accepted for compatibility; no removal version is scheduled.

position_gtnumber

Match keywords with a rank check position greater than this number. Also accepted as filter[position_gt].

position_ltnumber

Match keywords with a rank check position less than this number. Also accepted as filter[position_lt].

sort'created_at' | '-created_at' | 'keyword' | '-keyword' | 'text' | '-text' | 'updated_at' | '-updated_at'

Sort order for the keyword list.

filter[country]string

Alias of country. When both are sent, this alias wins.

filter[device]'desktop' | 'mobile'

Alias of device. When both are sent, this alias wins.

filter[intent]string

Alias of intent. When both are sent, this alias wins.

filter[location_key]string

Alias of location_key. When both are sent, this alias wins.

filter[position_gt]number

Alias of position_gt. When both are sent, this alias wins.

filter[position_lt]number

Alias of position_lt. When both are sent, this alias wins.

filter[tag]string

Alias of tag. When both are sent, this alias wins.

filter[topic]string

Alias of topic. When both are sent, this alias wins.

qstring

Alias of search. When both are sent, search wins.

Headers

Bisibility-API-Version'v1'

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

X-Bisibility-Source'sdk' | 'cli' | 'mcp'

Declares the client that produced the request for usage reporting: sdk, cli or mcp. Optional; any other value counts as api. It never changes authentication or which budget applies (every bearer-authenticated request counts against the API, MCP and SDK budget).

Response

JSON response

Example response

{
  "data": [
    {
      "country": "Austin, Texas, United States",
      "id": "kw_a00000000000000000000000",
      "latest_check": {
        "id": "check_a00000000000000000000000",
        "run_id": "rcr_a00000000000000000000000"
      },
      "latest_successful_check": {
        "id": "check_a00000000000000000000000",
        "run_id": "rcr_a00000000000000000000000"
      },
      "language_code": "en",
      "language_label": "English",
      "location": "Austin, Texas, United States",
      "location_key": "ES/Andalusia/Malaga@en",
      "project_id": "prj_a00000000000000000000000",
      "text": "rank tracker api"
    }
  ]
}

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added the new path request parameter project_id

    • info

      the endpoint scheme security AppOAuth was added to the API

    • info

      added the new optional query request parameter filter[country]

    • info

      added the new optional query request parameter filter[device]

    • info

      added the new optional query request parameter filter[intent]

    • info

      added the new optional query request parameter filter[location_key]

    • info

      added the new optional query request parameter filter[position_gt]

    • info

      added the new optional query request parameter filter[position_lt]

    • info

      added the new optional query request parameter filter[tag]

    • info

      added the new optional query request parameter filter[topic]

    • info

      added the new optional query request parameter q

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status