README.md

Configs

(configs)

Available Operations

• getExposureCount - Read Exposure Event Count
• changeValidation - Change Validation

getExposureCount

Get the count of exposure events recently received by Statsig.

Example Usage

import { Statsig } from "statsig";

const statsig = new Statsig({
  statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await statsig.configs.getExposureCount({});

  // Handle the result
  console.log(result)
}

run();

Standalone function

The standalone function version of this method:

import { StatsigCore } from "statsig/core.js";
import { configsGetExposureCount } from "statsig/funcs/configsGetExposureCount.js";

// Use `StatsigCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const statsig = new StatsigCore({
  statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await configsGetExposureCount(statsig, {});

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.ConsoleV1ExposureCountsControllerGenExposureCountRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ConsoleV1ExposureCountsControllerGenExposureCountResponseBody>

Errors

Error Object	Status Code	Content Type
errors.ConsoleV1ExposureCountsControllerGenExposureCountResponseBody	400	application/json
errors.ConsoleV1ExposureCountsControllerGenExposureCountConfigsResponseBody	401	application/json
errors.SDKError	4xx-5xx	/

changeValidation

Change Validation

Example Usage

import { Statsig } from "statsig";

const statsig = new Statsig({
  statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await statsig.configs.changeValidation({
    changeValidationDto: {
      name: "<value>",
      validated: false,
    },
  });

  // Handle the result
  console.log(result)
}

run();

Standalone function

The standalone function version of this method:

import { StatsigCore } from "statsig/core.js";
import { configsChangeValidation } from "statsig/funcs/configsChangeValidation.js";

// Use `StatsigCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const statsig = new StatsigCore({
  statsigApiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await configsChangeValidation(statsig, {
    changeValidationDto: {
      name: "<value>",
      validated: false,
    },
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.ConsoleV1ChangeValidationControllerChangeValidationRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ConsoleV1ChangeValidationControllerChangeValidationResponseBody>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/