> ## Documentation Index > Fetch the complete documentation index at: https://docs.goosybear.ai/llms.txt > Use this file to discover all available pages before exploring further. # Call analytics.query_metrics > 'how many visitors did we get last week?', 'what's our conversion rate?' — read this workspace's analytics numbers over a window: the same figures, from the same reads, the analytics pages show. Name dictionary keys (analytics.list_available_metrics lists them) and a preset period or an explicit from/to; set compare to also read the preceding window. Every row carries a state: empty is a final answer, read_failed means nothing is known, and suppressed means a small-count privacy floor withholds the figure. It changes nothing. Not for which metrics exist or report here — that is `analytics.list_available_metrics`. Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one. ## OpenAPI ````yaml /openapi.json post /api/v1/tools/analytics.query_metrics openapi: 3.1.0 info: title: Goosy Bear API version: 1.0.0-beta summary: Manage workspace content, projects, Data tables, Pages, library and credits. description: >- BETA. This API is in beta: paths, request shapes and response envelopes may change, and every response carries an `x-goosy-api: beta` header for as long as that is true. A change is additive, or it is deprecated first: a response to a call that uses a deprecated feature carries `Deprecation` and `Sunset` headers, and nothing is removed until at least 90 days after its deprecation. Pin the OpenAPI document you generated against and re-generate when it changes. servers: - url: https://app.goosybear.ai description: Production security: - tenantApiKey: [] paths: /api/v1/tools/analytics.query_metrics: post: tags: - analytics summary: Call analytics.query_metrics description: >- 'how many visitors did we get last week?', 'what's our conversion rate?' — read this workspace's analytics numbers over a window: the same figures, from the same reads, the analytics pages show. Name dictionary keys (analytics.list_available_metrics lists them) and a preset period or an explicit from/to; set compare to also read the preceding window. Every row carries a state: empty is a final answer, read_failed means nothing is known, and suppressed means a small-count privacy floor withholds the figure. It changes nothing. Not for which metrics exist or report here — that is `analytics.list_available_metrics`. Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one. operationId: call_analytics_query_metrics parameters: - name: x-request-id in: header required: false description: >- Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from `A–Z a–z 0–9 . _ : -`, starting with a letter or digit; anything else is replaced by a generated id. schema: type: string maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: metric_keys: type: array items: type: string enum: - rev_leads - rev_booked_calls - rev_calls_showed - rev_show_rate - rev_sales_won - rev_revenue_won - rev_revenue_by_source - rev_open_pipeline_value - email_sent - email_delivered - email_delivery_rate - email_opened - email_open_rate - email_clicked - email_click_rate - email_replied - email_complaint_rate - email_bounce_rate - list_size - list_new_subscribers - list_unsubscribe_rate - ads_spend - ads_impressions - ads_clicks - ads_ctr - ads_cpc - ads_cpm - ads_reach - ads_frequency - ads_conversions - ads_cost_per_lead - ads_cost_per_booked_call - ads_attributed_revenue - vid_views - vid_watch_time_minutes - vid_avg_view_duration - vid_impressions - vid_impressions_ctr - vid_subscribers_gained - vid_net_subscribers - vid_breakout_score - soc_posts_published - soc_impressions - soc_engagements - soc_engagement_rate - soc_meta_impressions - soc_meta_engagements - soc_meta_engagement_rate - soc_fb_impressions - soc_fb_engagements - soc_fb_engagement_rate - soc_ig_impressions - soc_ig_reach - soc_ig_engagements - soc_ig_engagement_rate - soc_ig_profile_visits - soc_ig_new_follows - sys_produced - hyros_attributed_revenue - hyros_attributed_leads - web_sessions - web_active_users - web_conversions - web_revenue - web_search_impressions - web_search_clicks - web_search_ctr - web_search_position minItems: 1 maxItems: 12 description: >- Dictionary metric keys to read. Use analytics.list_available_metrics to discover them. period: type: string enum: - 7d - 28d - 90d description: >- A preset window of whole COMPLETE periods ending at the start of the current one: 7d = the last 7 complete days (today is excluded), 28d = the last 4 complete weeks, 90d = the last 3 complete calendar months (92 days on a May-Aug read, not 90). Omit when supplying from/to. from: type: string description: >- Window start, ISO-8601 date or timestamp. Inclusive. Requires `to`. to: type: string description: Window end, ISO-8601 date or timestamp. EXCLUSIVE. grain: type: string enum: - hour - day - week - month - quarter - year - lifetime description: >- Granularity the stored rows are read at. LEAVE THIS UNSET unless you have a specific reason: day is where the analytics store is written, and asking for a coarser grain reads a different set of rows that is usually empty. A window is summed from day rows regardless of how long it is, so a month-long window does NOT need grain=month. compare: type: boolean description: >- Also read the immediately preceding window of the same number of COMPLETE periods, for a like-for-like comparison. On a preset that is a calendar step, so the preceding window holds the same number of weeks or months — not necessarily the same number of days. workspace: type: string minLength: 1 description: >- Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed. required: - metric_keys additionalProperties: false responses: '200': description: >- The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 x-goosy-tool-error: description: >- `true` when a boundary step refused the call — workspace resolution failed or could not be read. A tool that ran and returned its own typed `ok: false` reports `false` here. **Branch on `ok` in the body for the outcome; this header is the transport-level hint.** schema: type: string enum: - 'true' - 'false' content: application/json: schema: oneOf: - type: object description: The tool ran and answered. properties: ok: type: boolean const: true window: type: object properties: from: type: string to: type: string label: type: string required: - from - to - label additionalProperties: false previous_window: anyOf: - type: object properties: from: type: string to: type: string label: type: string required: - from - to - label additionalProperties: false - type: 'null' grain: type: string definition_version: type: integer min_delta_periods: type: integer metrics: type: array items: type: object properties: key: type: string label: type: string module: type: string formula: type: string source: type: string provenance: type: string aggregation: type: string definition_version: type: integer is_directional: type: boolean honesty_note: type: - string - 'null' floor: anyOf: - type: object properties: kind: type: string threshold: type: integer required: - kind - threshold additionalProperties: false - type: 'null' recompute_required: type: boolean current: type: object properties: value: type: - number - 'null' display: type: string row_count: type: integer minimum: 0 currency_code: type: - string - 'null' store: type: string enum: - metric_rollups - metric_snapshots - none suppressed: type: - string - 'null' required: - value - display - row_count - currency_code - store - suppressed additionalProperties: false previous: anyOf: - type: object properties: value: type: - number - 'null' display: type: string row_count: type: integer minimum: 0 currency_code: type: - string - 'null' store: type: string enum: - metric_rollups - metric_snapshots - none suppressed: type: - string - 'null' required: - value - display - row_count - currency_code - store - suppressed additionalProperties: false - type: 'null' change: anyOf: - type: object properties: absolute: type: number percent: type: - number - 'null' required: - absolute - percent additionalProperties: false - type: 'null' change_unavailable: type: - string - 'null' state: type: string enum: - reported - empty - not_aggregatable - suppressed - read_failed required: - key - label - module - formula - source - provenance - aggregation - definition_version - is_directional - honesty_note - floor - recompute_required - current - previous - change - change_unavailable - state additionalProperties: false all_empty: type: boolean answer_note: type: string workspace: type: string description: The slug of the workspace this call ran in. working_in: type: object properties: label: type: string description: 'The chip words — e.g. "working in: Acme Main".' note: type: string description: >- Why this workspace — e.g. "your default", "this call only". workspace: type: string description: The resolved workspace's slug. source: type: string enum: - call-override - key-pin - stored-default - sole-reachable description: >- Which rung of the R7 precedence resolved the workspace. required: - label - note - workspace - source additionalProperties: false description: >- Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result. required: - ok - all_empty - answer_note - definition_version - grain - metrics - min_delta_periods - previous_window - window - working_in - workspace - $ref: '#/components/schemas/ToolRefusal' '400': description: >- The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: >- No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- No such tool. The body names no tool and is identical for every unrecognised name. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 Retry-After: description: Whole seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: ToolRefusal: type: object properties: ok: type: boolean const: false code: type: string description: >- The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code. message: type: string description: A sentence a person can act on. workspaces: type: array items: type: string description: 'On a workspace refusal: the slugs this key may pass as `workspace`.' issues: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false description: 'On `invalid_arguments`: which fields failed, and why.' required: - ok - code - message additionalProperties: false description: A call that was admitted and dispatched, and did not succeed. Error: type: object properties: ok: type: boolean const: false code: type: string description: >- The typed refusal code — e.g. `tenant_mcp.surface_disabled`, `tenant_mcp.rate_limited`. message: type: string description: A sentence a person can act on. retry_after_seconds: type: number description: 'On a 429: whole seconds to wait. Mirrors `Retry-After`.' error: type: object properties: code: type: string message: type: string retry_after_seconds: type: number required: - code - message additionalProperties: false description: >- Deprecated: the same values as the top-level fields, kept until 2026-12-31. Read `code` and `message` at the top level. required: - ok - code - message - error additionalProperties: false description: >- A request the boundary refused before dispatching anything. The same shape the MCP endpoint answers its own refusals with, and the same top-level fields a dispatched call's refusal carries, so one client branch covers both. securitySchemes: tenantApiKey: type: http scheme: bearer description: >- An API key minted at Settings › API & MCP. Send it as `Authorization: Bearer `. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (`GOOSY_API_KEY`), never in a committed file. ````