Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 6.29 KB

README.md

File metadata and controls

85 lines (59 loc) · 6.29 KB

Usage

(usage)

Available Operations

getReportUrl

Get Report URL

Example Usage

import { Statsig } from "statsig";

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

async function run() {
  const result = await statsig.usage.getReportUrl({
    end: 42141,
  });

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

run();

Standalone function

The standalone function version of this method:

import { StatsigCore } from "statsig/core.js";
import { usageGetReportUrl } from "statsig/funcs/usageGetReportUrl.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 usageGetReportUrl(statsig, {
    end: 695278,
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.ConsoleV1UsageControllerGenReportRequest ✔️ 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.ConsoleV1UsageControllerGenReportResponseBody>

Errors

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