mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-09 20:37:49 +00:00
526 lines
50 KiB
Markdown
526 lines
50 KiB
Markdown
# Analytics
|
|
(*analytics*)
|
|
|
|
### Available Operations
|
|
|
|
* [clicks](#clicks) - Retrieve clicks analytics
|
|
* [timeseries](#timeseries) - Retrieve timeseries analytics
|
|
* [countries](#countries) - Retrieve country analytics
|
|
* [cities](#cities) - Retrieve city analytics
|
|
* [devices](#devices) - Retrieve device analytics
|
|
* [browsers](#browsers) - Retrieve browser analytics
|
|
* [os](#os) - Retrieve OS analytics
|
|
* [referers](#referers) - Retrieve referer analytics
|
|
* [topLinks](#toplinks) - Retrieve top links
|
|
* [topUrls](#topurls) - Retrieve top URLs
|
|
|
|
## clicks
|
|
|
|
Retrieve the number of clicks for a link, a domain, or the authenticated workspace.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.clicks({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetClicksAnalyticsRequest](../../models/operations/getclicksanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[number](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## timeseries
|
|
|
|
Retrieve the number of clicks for a link, a domain, or the authenticated workspace over a period of time.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.timeseries({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetTimeseriesAnalyticsRequest](../../models/operations/gettimeseriesanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.ResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## countries
|
|
|
|
Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.countries({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetCountryAnalyticsRequest](../../models/operations/getcountryanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetCountryAnalyticsResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## cities
|
|
|
|
Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.cities({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetCityAnalyticsRequest](../../models/operations/getcityanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetCityAnalyticsResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## devices
|
|
|
|
Retrieve the top devices by number of clicks for a link, a domain, or the authenticated workspace.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.devices({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetDeviceAnalyticsRequest](../../models/operations/getdeviceanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetDeviceAnalyticsResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## browsers
|
|
|
|
Retrieve the top browsers by number of clicks for a link, a domain, or the authenticated workspace.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.browsers({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetBrowserAnalyticsRequest](../../models/operations/getbrowseranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetBrowserAnalyticsResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## os
|
|
|
|
Retrieve the top OS by number of clicks for a link, a domain, or the authenticated workspace.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.os({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetOSAnalyticsRequest](../../models/operations/getosanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetOSAnalyticsResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## referers
|
|
|
|
Retrieve the top referers by number of clicks for a link, a domain, or the authenticated workspace.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.referers({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetRefererAnalyticsRequest](../../models/operations/getrefereranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetRefererAnalyticsResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## topLinks
|
|
|
|
Retrieve the top links by number of clicks for a domain or the authenticated workspace.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.topLinks({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetTopLinksRequest](../../models/operations/gettoplinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetTopLinksResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|
|
|
|
## topUrls
|
|
|
|
Retrieve the top URLs by number of clicks for a given short link.
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Dub } from "dub";
|
|
|
|
const dub = new Dub({
|
|
token: "DUB_API_KEY",
|
|
workspaceId: "<value>",
|
|
});
|
|
|
|
async function run() {
|
|
const result = await dub.analytics.topUrls({});
|
|
|
|
// Handle the result
|
|
console.log(result)
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetTopURLsRequest](../../models/operations/gettopurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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. |
|
|
|
|
|
|
### Response
|
|
|
|
**Promise<[operations.GetTopURLsResponseBody[]](../../models/.md)>**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
| errors.BadRequest | 400 | application/json |
|
|
| errors.Unauthorized | 401 | application/json |
|
|
| errors.Forbidden | 403 | application/json |
|
|
| errors.NotFound | 404 | application/json |
|
|
| errors.Conflict | 409 | application/json |
|
|
| errors.InviteExpired | 410 | application/json |
|
|
| errors.UnprocessableEntity | 422 | application/json |
|
|
| errors.RateLimitExceeded | 429 | application/json |
|
|
| errors.InternalServerError | 500 | application/json |
|
|
| errors.SDKError | 4xx-5xx | */* |
|