> ## Documentation Index > Fetch the complete documentation index at: https://docs.gaintrace.com/llms.txt > Use this file to discover all available pages before exploring further. # Get survey coverage > Who you hear from inside the rollup window: Companies, ARR and decision makers, plus Companies renewing in the next 90 days with no feedback in 180 days. Requires a secret server key (`gt_live_`). Publishable keys (`gt_pub_`) return `403`. **Scope:** `read:surveys` ## OpenAPI ````yaml /openapi.json get /surveys/coverage openapi: 3.1.0 info: title: GainTrace API version: 1.0.0 description: >- The GainTrace REST API (v1). Read your customer data and push product-usage events, metric events, and signals into GainTrace. All endpoints are authenticated with a Bearer API key and scoped to a single workspace. Each API key can send 60 requests a minute. A `429` response includes a `Retry-After` header with the seconds to wait. servers: - url: https://app.gaintrace.com/api/v1 description: Production security: - bearerAuth: [] tags: - name: Companies description: Read and manage canonical company records. - name: Signals description: Read, create, and manage buyer / risk signals. - name: Ingest description: Push product-usage and metric events into GainTrace. - name: Contacts description: >- The original path for People. It shares its handlers with /people, and also offers delete-by-key. - name: Webhooks description: Subscribe to workspace events with signed, retried delivery. - name: People description: Read and manage People. One Person can belong to many Companies. - name: NPS responses description: Import NPS scores from another survey tool and read your NPS history. - name: Surveys description: >- Create and launch surveys, request invitations, record responses and mint in-app sessions. - name: Survey responses description: Read the responses collected by your surveys. - name: Survey segments description: Save groups of Companies and People that surveys can target. - name: Survey imports description: Pull responses from the survey tools your workspace has connected. paths: /surveys/coverage: get: tags: - Surveys summary: Get survey coverage description: >- Who you hear from inside the rollup window: Companies, ARR and decision makers, plus Companies renewing in the next 90 days with no feedback in 180 days. Requires a secret server key (`gt_live_`). Publishable keys (`gt_pub_`) return `403`. **Scope:** `read:surveys` operationId: getSurveyCoverage responses: '200': description: Coverage. content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/SurveyCoverage' example: data: windowDays: 365 companies: 42 companiesHeard: 17 companiesWithDecisionMaker: 9 reportingCurrency: USD arrTotal: 48200000 arrHeard: 29150000 unconvertedCurrencies: [] silentRenewals: count: 1 companies: - id: 9b2f6c1e-5d4a-4c3b-8a1f-2e7d9c0b6a55 name: Northwind Traders renewalDate: '2026-11-20T00:00:00.000Z' arr: 6400000 currency: USD companiesInferredOnly: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalServerError' '503': $ref: '#/components/responses/ServiceUnavailable' '504': $ref: '#/components/responses/GatewayTimeout' components: schemas: SurveyCoverage: type: object required: - windowDays - companies - companiesHeard - companiesWithDecisionMaker - reportingCurrency - arrTotal - arrHeard - unconvertedCurrencies - silentRenewals properties: windowDays: type: integer description: The rollup window answers are counted in. companies: type: integer description: Companies that aren't archived. companiesHeard: type: integer description: >- Companies with a scored answer in the window, scored answers from your surveys or imported NPS. companiesWithDecisionMaker: type: integer description: Of those, how many had a decision maker or executive sponsor answer. reportingCurrency: type: string description: The workspace reporting currency the ARR figures are in. arrTotal: type: - integer - 'null' description: >- ARR of all Companies in minor units of the reporting currency. Null when no Company has ARR. arrHeard: type: - integer - 'null' description: >- ARR of the Companies heard from, in minor units of the reporting currency. unconvertedCurrencies: type: array items: type: string description: >- Currencies left out of the ARR figures because no exchange rate exists for them yet. silentRenewals: type: object required: - count - companies description: >- Companies renewing in the next 90 days that nobody has heard from in 180 days. properties: count: type: integer companies: type: array description: Up to 10, largest ARR first. items: type: object required: - id - name - renewalDate - arr - currency properties: id: type: string format: uuid name: type: string renewalDate: type: string format: date-time arr: type: - integer - 'null' currency: type: string companiesInferredOnly: type: - integer - 'null' description: >- Companies that have an inferred satisfaction score but no scored survey answer in the window. `null` until an admin turns on inferred satisfaction and it has enough People to calibrate. These Companies are never counted in `companiesHeard`. Error: type: object required: - error description: The standard error envelope. Every 4xx/5xx response uses this shape. properties: error: type: object required: - code - message properties: code: type: string enum: - bad_request - unauthorized - payment_required - forbidden - not_found - conflict - unprocessable_entity - rate_limit_exceeded - internal_server_error - service_unavailable - gateway_timeout description: >- Stable, machine-readable error code. Each code maps to exactly one HTTP status. message: type: string description: >- Human-readable, safe description of what went wrong. Never contains internal or provider detail. doc_url: type: string format: uri example: https://docs.gaintrace.com/errors#not_found description: Deep link to this code in the Errors reference. responses: Unauthorized: description: Missing, malformed, expired, or revoked API key. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: unauthorized message: Missing Authorization header doc_url: https://docs.gaintrace.com/errors#unauthorized Forbidden: description: >- The key is valid but lacks the required scope, the origin is not allowed, or API v1 is not enabled for the workspace. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: forbidden message: 'Insufficient scope: write:companies required' doc_url: https://docs.gaintrace.com/errors#forbidden RateLimited: description: >- The per-key rate limit was exceeded. Each API key can send 60 requests per minute, counted in calendar-minute windows. The `Retry-After` header gives the whole seconds (1 to 60) until the next window opens. Wait that long, then retry. headers: Retry-After: description: Whole seconds until the next one-minute window starts. schema: type: integer minimum: 1 maximum: 60 example: 23 content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: rate_limit_exceeded message: >- Can't accept more than 60 requests a minute from one API key. Retry in 23 seconds. doc_url: https://docs.gaintrace.com/errors#rate_limit_exceeded InternalServerError: description: >- An unexpected error occurred on our side. The failure is logged; retry shortly. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: internal_server_error message: Something went wrong. Try again in a moment. doc_url: https://docs.gaintrace.com/errors#internal_server_error ServiceUnavailable: description: >- A backing service (for example, the database) was temporarily unavailable. Retry shortly. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: service_unavailable message: We had trouble reaching the database. Try again in a moment. doc_url: https://docs.gaintrace.com/errors#service_unavailable GatewayTimeout: description: >- The request took too long upstream before completing. Retry, and reduce batch size for large payloads. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: gateway_timeout message: The request timed out. Try again in a moment. doc_url: https://docs.gaintrace.com/errors#gateway_timeout securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer API key. Secret server keys start with `gt_live_`; client-safe browser keys start with `gt_pub_` (write-only, origin-pinned). Create and scope keys in Settings → API Keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.