---
title: "Get Private Link Config"
method: GET
path: "/api/sites/{site}/private-link-config"
tags: ["Sites"]
---

# Get Private Link Config

`GET /api/sites/{site}/private-link-config`

## Request

- Base URL: `https://app.onyxmetric.com`
- URL: `https://app.onyxmetric.com/api/sites/{site}/private-link-config`
- Auth: one of:
  - HTTP bearer
  - API key in query parameter `api_key`
  - API key in cookie `better-auth.session_token`

Returns the private link key configuration. Private links allow sharing analytics with a secret key without requiring authentication.

## Path parameters

- `site` union, required
  - integer
  - string

## Response `200`

Successful response. Refer to the linked endpoint documentation for the response fields.

- unknown

## Other responses

- `400`: Invalid request
- `401`: Authentication required
- `403`: Insufficient permission
- `404`: Resource not found
- `429`: Rate limit exceeded
- `500`: Unexpected server error

---

[API](https://skmtc.dev/onyxmetric/apis/onyxmetric-api.md) · [All operations](https://skmtc.dev/onyxmetric/apis/onyxmetric-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onyxmetric/apis/onyxmetric-api/revisions/c99014014805?raw)