analytics

List search query statistics

Changed on
get/projects/{project_id}/analytics/query-stats

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/analytics/query-stats
  • 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

start_datestring required
end_datestring required
connection_idstring
querystring
limitinteger
clicks_mininteger

Inclusive lower bound on clicks.

impressions_mininteger

Inclusive lower bound on impressions.

position_maxnumber

Inclusive upper bound on average position.

page_pathstring

Page path filter; setting it also groups rows by page.

page_path_match'contains' | 'prefix'

contains keeps rows whose page URL contains the given path; prefix matches pages whose URL starts with the source property host followed by the path.

query_match'equals' | 'contains'

Match semantics for the query filter; default equals is exact match.

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

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added the new path request parameter project_id

    • breaking

      for the query request parameter connection_id, the minLength was increased from 0 to 1

    • breaking

      for the query request parameter page_path, the minLength was increased from 0 to 1

    • breaking

      for the query request parameter query, the minLength was increased from 0 to 1

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}$ to the query request parameter end_date

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}$ to the query request parameter start_date

    • warning

      for the query request parameter connection_id, the maxLength was set to 120

    • info

      the endpoint scheme security AppOAuth was added to the API

    • info

      for the query request parameter end_date, the format was generalized from date to no format

    • info

      for the query request parameter start_date, the format was generalized from date to no format

    • 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

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