keywords

Add one or more keywords

Changed on
post/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:write)

Path parameters

project_idstring required

Public project ID; membership and token scope are enforced.

Example:prj_a00000000000000000000000

Headers

Bisibility-API-Version'v1'

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

Idempotency-Keystring

Optional key that makes a retry of this request return the first response instead of running it again. Replays last 24 hours and are scoped to the credential, method and path.

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).

Request body

OR
OR

Response

JSON response

createdinteger required
skippedinteger required
warningsstring[]

Example response

{
  "results": [
    {
      "keyword": {
        "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

    • breaking

      added required request body

    • breaking

      the response's property type changed from array to integer for status

    • info

      the endpoint scheme security AppOAuth was added to the API

    • info

      added the new optional header request parameter Idempotency-Key

    • 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

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the success response with the status