> ## Documentation Index
> Fetch the complete documentation index at: https://statsig-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Get one layer
## OpenAPI
````yaml api-reference/statsig_openapi.json get /console/v1/layers/{id}
openapi: 3.0.0
info:
title: Console API
description: >-
The "Console API" is the CRUD API for performing the actions offered on
console.statsig.com without needing to go through the web UI.
If you have any feature requests, drop on in to our [slack
channel](https://www.statsig.com/slack) and let us know.
Authorization
All requests must include the **STATSIG-API-KEY** field in the header. The
value should be a **Console API Key** which can be created in the Project
Settings on
[console.statsig.com/api_keys](https://console.statsig.com/api_keys)
Rate Limiting
Requests to the Console API are limited to ~ 100reqs / 10secs and ~
900reqs / 15 mins.
Keyboard Search
Use Ctrl/Cmd + K to search for specific endpoints.
version: 20240601.0.0
contact: {}
servers:
- url: https://statsigapi.net
security: []
tags: []
paths:
/console/v1/layers/{id}:
get:
tags:
- Layers
summary: Get one layer
parameters:
- name: id
required: true
in: path
description: id
schema:
type: string
- name: x-respect-review-settings
in: header
description: Optional header to respect review settings for mutation endpoints.
required: false
schema:
type: string
responses:
'200':
description: Get one layer response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SingleDataResponse'
- properties:
data:
$ref: '#/components/schemas/LayerContractDto'
example:
message: Layer read successfully.
data:
id: the_best_layer
description: helpful summary of what this layer does
idType: userID
lastModifierID: 4dcQUIpS8PHObBGD7HJwOx
lastModifiedTime: 1720733945538
lastModifierName: CONSOLE API
lastModifierEmail: null
creatorID: 4dcQUIpS8PHObBGD7HJwOx
createdTime: 1720733942515
creatorName: CONSOLE API
creatorEmail: null
targetApps:
- Android
holdoutIDs:
- global_holdout
- test_holdout
tags: []
team: Console Team
isImplicitLayer: false
parameters: []
example:
message: Layer read successfully.
data:
id: the_best_layer
description: helpful summary of what this layer does
idType: userID
lastModifierID: 4dcQUIpS8PHObBGD7HJwOx
lastModifiedTime: 1720733945538
lastModifierName: CONSOLE API
lastModifierEmail: null
creatorID: 4dcQUIpS8PHObBGD7HJwOx
createdTime: 1720733942515
creatorName: CONSOLE API
creatorEmail: null
targetApps:
- Android
holdoutIDs:
- global_holdout
- test_holdout
tags: []
team: Console Team
isImplicitLayer: false
parameters: []
'400':
description: Invalid request. Please check the request input and try again.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 400
message:
type: string
required:
- status
- message
examples:
Invalid Request:
value:
status: 400
message: >-
Invalid request. Please check the request input and try
again.
'401':
description: >-
This endpoint only accepts an active CONSOLE key, but an invalid key
was sent. Key: console-xxxXXXxxxXXXxxx
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 401
message:
type: string
required:
- status
- message
examples:
Invalid Endpoint:
value:
status: 401
message: >-
This endpoint only accepts an active CONSOLE key, but an
invalid key was sent. Key: console-xxxXXXxxxXXXxxx
'404':
description: Not Found. The requested resource could not be found.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 404
message:
type: string
required:
- status
- message
examples:
Not Found:
value:
status: 404
message: Not Found. The requested resource could not be found.
security:
- STATSIG-API-KEY: []
components:
schemas:
SingleDataResponse:
type: object
properties:
message:
type: string
description: A simple string explaining the result of the operation.
data:
type: object
description: A single result.
required:
- message
- data
LayerContractDto:
type: object
properties:
id:
type: string
description: ID
name:
type: string
description: Optional name for the configuration.
idType:
type: string
description: The ID type used for this layer, important for validation.
description:
type: string
maxLength: 1000
description: >-
A detailed description of the layer, explaining its purpose and
functionality.
lastModifierID:
type: string
nullable: true
description: ID of the last modifier.
lastModifiedTime:
type: number
nullable: true
description: Time of the last modification.
lastModifierEmail:
type: string
nullable: true
description: Email of the last modifier.
lastModifierName:
type: string
nullable: true
description: Name of the last modifier.
creatorID:
type: string
nullable: true
description: ID of the user who created the entity.
createdTime:
type: number
description: Timestamp when the entity was created.
creatorName:
type: string
nullable: true
description: Name of the creator.
creatorEmail:
type: string
nullable: true
description: Email of the creator.
tags:
type: array
items:
type: string
description: Optional tags for categorization.
targetApps:
oneOf:
- type: string
- type: array
items:
type: string
description: List of target applications that this layer is intended for.
holdoutIDs:
type: array
items:
type: string
description: Holdouts applied to this configuration.
team:
type: string
nullable: true
description: Optional name for the responsible team.
teamID:
type: string
nullable: true
description: Optional ID of the responsible team.
version:
type: number
description: Version number
isImplicitLayer:
type: boolean
description: >-
Indicates if the layer was automatically created by Statsig during
experiment creation.
parameters:
type: array
items:
type: object
properties:
name:
type: string
description: >-
The name of this parameter, used for identification within the
layer.
type:
type: string
enum:
- string
- number
- boolean
- object
- array
description: >-
The data type that this parameter returns. Allowed types
include: string, boolean, number, object, and array.
defaultValue:
oneOf:
- type: string
- type: number
- type: boolean
- type: object
additionalProperties: {}
- type: array
items:
oneOf:
- type: string
- type: number
- type: boolean
- type: object
additionalProperties: {}
description: >-
The default value for this parameter, which must match the
specified type.
required:
- name
- type
- defaultValue
description: >-
An array of parameters associated with the layer, each defining
specific attributes.
required:
- id
- idType
- description
- lastModifierID
- lastModifiedTime
- lastModifierEmail
- lastModifierName
- creatorID
- createdTime
- creatorName
- creatorEmail
- isImplicitLayer
- parameters
securitySchemes:
STATSIG-API-KEY:
type: apiKey
name: STATSIG-API-KEY
in: header
````