> ## Documentation Index > Fetch the complete documentation index at: https://highseat.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a share link > Makes a read-only board of the site that opens without an account, as the dashboard's Sharing settings do. The filters are fixed at creation: an update cannot change them. A site has at most 100 share links: one more answers 422 `SHARE_LINK_LIMIT_REACHED`. ## OpenAPI ````yaml https://api.highseat.com/v1/openapi.json post /sites/{site}/share-links openapi: 3.1.1 info: title: Highseat Stats API version: 1.0.0 description: >- The same figures the dashboard shows, and the changes an admin makes there. A read key answers every GET route; a write key also answers the routes that change data. Authentication, write keys, idempotency, limits and the shape of every response: https://highseat.com/docs/api. license: name: Proprietary servers: - url: https://api.highseat.com/v1 security: - bearerAuth: [] paths: /sites/{site}/share-links: post: tags: - Share links summary: Create a share link description: >- Makes a read-only board of the site that opens without an account, as the dashboard's Sharing settings do. The filters are fixed at creation: an update cannot change them. A site has at most 100 share links: one more answers 422 `SHARE_LINK_LIMIT_REACHED`. operationId: createShareLink parameters: - name: site in: path required: true schema: type: string description: 'The site: its domain as registered (example.com), or its site id.' - name: Idempotency-Key in: header required: false description: >- Any unique string up to 255 characters, such as a UUID. A retry with the same key and body within 24 hours answers what the first call did, without writing again. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 description: The link's name, for the site's own list. password: type: string minLength: 6 maxLength: 200 description: >- A password the viewer types before the board opens, 6 to 200 characters. Never returned. expiresAt: type: string format: date description: >- The last day the link opens, YYYY-MM-DD in the site's timezone. filters: type: array maxItems: 20 items: type: string default: [] description: >- Filters the viewer cannot remove, each written as a report's `filter` parameter, dimension[.key]:operator:value, such as page_path:contains:/blog. showNotes: type: boolean description: Whether the link shows the chart's notes. default: false showRevenue: type: boolean description: Whether the link shows revenue. default: false hideBranding: type: boolean description: Whether the board hides the product's branding. default: false required: - name responses: '201': description: OK content: application/json: schema: type: object properties: data: type: object properties: id: type: string name: type: string url: type: string description: The board's address, which the viewer opens. expiresAt: anyOf: - type: string format: date-time x-native-type: date - type: 'null' description: >- ISO 8601 in UTC: the first instant the link no longer opens. Null for never. filters: type: array items: type: string description: >- The filters the viewer cannot remove, written as a report's `filter` parameter. showNotes: type: boolean description: Whether the link shows the chart's notes. showRevenue: type: boolean description: Whether the link shows revenue. hideBranding: type: boolean description: Whether the board hides the product's branding. hasPassword: type: boolean description: Whether the link asks for a password. createdAt: type: string format: date-time x-native-type: date required: - id - name - url - expiresAt - filters - showNotes - showRevenue - hideBranding - hasPassword - createdAt required: - data headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' '400': $ref: '#/components/responses/WriteError400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/WriteError403' '404': $ref: '#/components/responses/Error404' '409': $ref: '#/components/responses/WriteError409' '413': $ref: '#/components/responses/WriteError413' '422': $ref: '#/components/responses/WriteError422' '429': $ref: '#/components/responses/Error429' '503': $ref: '#/components/responses/Error503' components: headers: RateLimit-Limit: description: Calls the key may make in the window. schema: type: integer RateLimit-Remaining: description: Calls left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the window reopens. schema: type: integer RateLimit-Policy: description: >- The quota and window, as the IETF draft writes it: "hourly";q=600;w=3600. schema: type: string RateLimit: description: >- The remaining budget, as the IETF draft writes it: "hourly";r=599;t=3540. schema: type: string Retry-After: description: Seconds to wait before the next call. schema: type: integer responses: WriteError400: description: >- The request is malformed, or its Idempotency-Key is not 1 to 255 characters: BAD_REQUEST. headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json: schema: $ref: '#/components/schemas/Error' Error401: description: 'No API key, or one that is not valid: UNAUTHORIZED.' headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json: schema: $ref: '#/components/schemas/Error' WriteError403: description: >- The key can only read (KEY_READ_ONLY), or the workspace is closed until it pays and takes no changes (FORBIDDEN). headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json: schema: $ref: '#/components/schemas/Error' Error404: description: 'The site, the row the path names or the route does not exist: NOT_FOUND.' headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json: schema: $ref: '#/components/schemas/Error' WriteError409: description: >- The change conflicts with a row that exists (CONFLICT, or the write's own code, which carries the row's `id`), or a request with the same Idempotency-Key still runs (IDEMPOTENCY_KEY_IN_USE). headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json: schema: $ref: '#/components/schemas/Error' WriteError413: description: 'The body is over 1 MB: PAYLOAD_TOO_LARGE.' headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json: schema: $ref: '#/components/schemas/Error' WriteError422: description: >- The Idempotency-Key was sent with another request in the last 24 hours (IDEMPOTENCY_KEY_REUSED), or the site already has as many rows of this kind as it may save (the write's own code, such as GOAL_LIMIT_REACHED). headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json: schema: $ref: '#/components/schemas/Error' Error429: description: >- The key has used its hourly budget (RATE_LIMITED), or its workspace already runs as many calls at once as it may (TOO_MANY_CONCURRENT_REQUESTS). headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/Error' Error503: description: 'The server is busy; retry in a moment: SERVICE_UNAVAILABLE.' headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object properties: error: type: object properties: code: type: string description: >- Stable and machine-readable: BAD_REQUEST, INVALID_FILTER, INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY, NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE, PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT, RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE or INTERNAL_SERVER_ERROR. A write may answer a code of its own: a conflict (GOAL_EXISTS, DOMAIN_TAKEN) or a limit (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED, SHARE_LINK_LIMIT_REACHED). Codes are added, never renamed. message: type: string description: What went wrong, written for a person. id: type: string description: >- On a conflict, the existing row's id, so a client can update it instead. issues: type: array items: type: object properties: path: type: array items: anyOf: - type: string - type: number description: >- The parameter at fault, e.g. ['filter', 1] for the second filter. message: type: string required: - path - message description: One entry per invalid parameter. required: - code - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.