openapi: 3.1.0
info:
title: Statsig Client SDK Audit Logs Tags API
description: The Statsig Client SDK API provides endpoints that power Statsig's client-side SDKs for JavaScript, React, React Native, iOS, Android, Unity, and other platforms. Client SDKs use Client-SDK Keys that are safe to embed in mobile apps and front-end web applications. They access the initialize endpoint to retrieve all evaluated gates, configs, and experiments for a given user, and the log_event endpoint for sending analytics events. The SDKs handle local evaluation, caching, and automatic error handling for performant client-side feature flagging.
version: 1.0.0
contact:
name: Statsig Support
url: https://statsig.com/support
termsOfService: https://statsig.com/terms
servers:
- url: https://api.statsig.com/v1
description: Statsig API Server
security:
- clientSdkKey: []
tags:
- name: Tags
paths:
/tags:
get:
operationId: listTags
summary: List all tags
description: Retrieves a list of all tags used for organizing entities in the project.
tags:
- Tags
parameters:
- $ref: '#/components/parameters/ApiVersion'
responses:
'200':
description: List of tags
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Tag'
'401':
$ref: '#/components/responses/Unauthorized'
post:
operationId: createTag
summary: Create a tag
description: Creates a new tag for organizing entities in the project.
tags:
- Tags
parameters:
- $ref: '#/components/parameters/ApiVersion'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagCreate'
responses:
'201':
description: Tag created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
components:
responses:
BadRequest:
description: Invalid request parameters
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error message describing what was wrong with the request.
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error message describing the authentication failure.
schemas:
TagCreate:
type: object
description: Request body for creating a new tag.
required:
- name
properties:
name:
type: string
description: The name of the tag to create.
description:
type: string
description: A human-readable description.
color:
type: string
description: The color for the tag.
Tag:
type: object
description: A tag used for organizing and categorizing entities.
properties:
id:
type: string
description: The unique identifier of the tag.
name:
type: string
description: The name of the tag.
description:
type: string
description: A human-readable description.
color:
type: string
description: The color associated with the tag for display.
parameters:
ApiVersion:
name: STATSIG-API-VERSION
in: header
required: false
schema:
type: string
default: '20240601'
description: The Console API version. Currently the only version is 20240601.
securitySchemes:
clientSdkKey:
type: apiKey
in: header
name: statsig-api-key
description: Client-SDK Key that is safe to embed in mobile apps and front-end web applications. Created in Project Settings > API Keys tab.
externalDocs:
description: Statsig Client SDK Documentation
url: https://docs.statsig.com/client/introduction