projects

Get project defaults

Changed on
get/projects/{project_id}/defaults

Request

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

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

citystring nullable required
countrystring required

Persisted default country for new keywords.

cron_expressionstring nullable required
device'desktop' | 'mobile' required

Persisted default device for new keywords and moved default-market keywords.

frequency'paused' | 'manual' | 'daily' | 'weekly' | 'monthly' | 'custom_cron' required
jitter_minutesinteger required

Whole-minute random delay from 0 to 120. Set 0 to disable jitter.

last_checked_atstring date-time nullable required
location_keystring required

Persisted canonical location key for the default market.

next_check_atstring date-time nullable required
project_idstring required
serp_depth10 | 20 | 50 | 100 required
serp_stop_on_matchboolean required

Stops a SERP crawl after the tracked domain is found.

source'derived' | 'explicit' | 'fallback' required

How the effective default market was selected.

timezonestring required

IANA time zone that anchors monthly and custom cron wall-clock schedules. Daily and weekly use a stable keyword-specific interval phase that timezone does not move.

updated_atstring date-time nullable

Example response

{
  "country": "United States",
  "location_key": "ES/Andalusia/Malaga@en",
  "project_id": "prj_a00000000000000000000000"
}

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added the new path request parameter project_id

    • info

      the endpoint scheme security AppOAuth was added to the API

    • 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