ShareLinkResponse

Fields

11 fields

access_count

integer

created_at · required

string

created_by_name

string or null

expires_at · required

string

id · required

string

is_revoked

boolean

report_layout · required

string

share_url

string or null

snapshot_ready

boolean or null

token

string or null

warning

string or null

Raw schema (JSON)

{
  "properties": {
    "access_count": {
      "default": 0,
      "title": "Access Count",
      "type": "integer"
    },
    "created_at": {
      "title": "Created At",
      "type": "string"
    },
    "created_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By Name"
    },
    "expires_at": {
      "title": "Expires At",
      "type": "string"
    },
    "id": {
      "title": "Id",
      "type": "string"
    },
    "is_revoked": {
      "default": false,
      "title": "Is Revoked",
      "type": "boolean"
    },
    "report_layout": {
      "title": "Report Layout",
      "type": "string"
    },
    "share_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Share Url"
    },
    "snapshot_ready": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Snapshot Ready"
    },
    "token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Token"
    },
    "warning": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Warning"
    }
  },
  "required": [
    "id",
    "report_layout",
    "expires_at",
    "created_at"
  ],
  "title": "ShareLinkResponse",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/reports/runs/{run_id}/share — Create Share Link Endpoint
• GET /api/v1/reports/runs/{run_id}/share-links — List Share Links Endpoint

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON