mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 04:19:37 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.292.0
This commit is contained in:
speakeasybot
@@ -3,71 +3,21 @@
|
||||
|
||||
### 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
|
||||
* [~~timeseries~~](#timeseries) - Retrieve timeseries click analytics :warning: **Deprecated** Use `timeseries` instead.
|
||||
* [~~country~~](#country) - Retrieve top countries by clicks :warning: **Deprecated** Use `countries` instead.
|
||||
* [~~city~~](#city) - Retrieve top cities by clicks :warning: **Deprecated** Use `cities` instead.
|
||||
* [~~device~~](#device) - Retrieve top devices by clicks :warning: **Deprecated** Use `devices` instead.
|
||||
* [~~browser~~](#browser) - Retrieve top browsers by clicks :warning: **Deprecated** Use `browsers` instead.
|
||||
* [~~os~~](#os) - Retrieve top OS by clicks :warning: **Deprecated** Use `os` instead.
|
||||
* [~~referer~~](#referer) - Retrieve top referers by clicks :warning: **Deprecated** Use `referers` instead.
|
||||
* [~~topLinks~~](#toplinks) - Retrieve top links by clicks :warning: **Deprecated** Use `topLinks` instead.
|
||||
* [~~topUrls~~](#topurls) - Retrieve top URLs by clicks :warning: **Deprecated** Use `topUrls` instead.
|
||||
|
||||
## clicks
|
||||
## ~~timeseries~~
|
||||
|
||||
Retrieve the number of clicks for a link, a domain, or the authenticated workspace.
|
||||
Retrieve timeseries click analytics 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.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.
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.timeseries instead.. Use `timeseries` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
@@ -93,14 +43,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetTimeseriesAnalyticsRequest](../../models/operations/gettimeseriesanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetTimeseriesByClicksDeprecatedRequest](../../models/operations/gettimeseriesbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetTimeseriesByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
@@ -116,10 +66,12 @@ run();
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## countries
|
||||
## ~~country~~
|
||||
|
||||
Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
|
||||
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.countries instead.. Use `countries` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
@@ -131,7 +83,7 @@ const dub = new Dub({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.countries({});
|
||||
const result = await dub.analytics.country({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -144,14 +96,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetCountryAnalyticsRequest](../../models/operations/getcountryanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetCountriesByClicksDeprecatedRequest](../../models/operations/getcountriesbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetCountriesByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
@@ -167,10 +119,12 @@ run();
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## cities
|
||||
## ~~city~~
|
||||
|
||||
Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
|
||||
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.cities instead.. Use `cities` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
@@ -182,7 +136,7 @@ const dub = new Dub({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.cities({});
|
||||
const result = await dub.analytics.city({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -195,14 +149,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetCityAnalyticsRequest](../../models/operations/getcityanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetCitiesByClicksDeprecatedRequest](../../models/operations/getcitiesbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetCitiesByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
@@ -218,10 +172,12 @@ run();
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## devices
|
||||
## ~~device~~
|
||||
|
||||
Retrieve the top devices by number of clicks for a link, a domain, or the authenticated workspace.
|
||||
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.devices instead.. Use `devices` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
@@ -233,7 +189,7 @@ const dub = new Dub({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.devices({});
|
||||
const result = await dub.analytics.device({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -246,14 +202,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetDeviceAnalyticsRequest](../../models/operations/getdeviceanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetDevicesByClicksDeprecatedRequest](../../models/operations/getdevicesbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetDevicesByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
@@ -269,10 +225,12 @@ run();
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## browsers
|
||||
## ~~browser~~
|
||||
|
||||
Retrieve the top browsers by number of clicks for a link, a domain, or the authenticated workspace.
|
||||
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.browsers instead.. Use `browsers` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
@@ -284,7 +242,7 @@ const dub = new Dub({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.browsers({});
|
||||
const result = await dub.analytics.browser({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -297,14 +255,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetBrowserAnalyticsRequest](../../models/operations/getbrowseranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetBrowsersByClicksDeprecatedRequest](../../models/operations/getbrowsersbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetBrowsersByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
@@ -320,10 +278,12 @@ run();
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## os
|
||||
## ~~os~~
|
||||
|
||||
Retrieve the top OS by number of clicks for a link, a domain, or the authenticated workspace.
|
||||
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.os instead.. Use `os` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
@@ -348,14 +308,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetOSAnalyticsRequest](../../models/operations/getosanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetOSByClicksDeprecatedRequest](../../models/operations/getosbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetOSByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
@@ -371,10 +331,12 @@ run();
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## referers
|
||||
## ~~referer~~
|
||||
|
||||
Retrieve the top referers by number of clicks for a link, a domain, or the authenticated workspace.
|
||||
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.referers instead.. Use `referers` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
@@ -386,7 +348,7 @@ const dub = new Dub({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.referers({});
|
||||
const result = await dub.analytics.referer({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -399,14 +361,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetRefererAnalyticsRequest](../../models/operations/getrefereranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetReferersByClicksDeprecatedRequest](../../models/operations/getreferersbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetReferersByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
@@ -422,10 +384,12 @@ run();
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## topLinks
|
||||
## ~~topLinks~~
|
||||
|
||||
Retrieve the top links by number of clicks for a domain or the authenticated workspace.
|
||||
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.topLinks instead.. Use `topLinks` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
@@ -450,14 +414,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetTopLinksRequest](../../models/operations/gettoplinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetTopLinksByClicksDeprecatedRequest](../../models/operations/gettoplinksbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetTopLinksByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
@@ -473,10 +437,12 @@ run();
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## topUrls
|
||||
## ~~topUrls~~
|
||||
|
||||
Retrieve the top URLs by number of clicks for a given short link.
|
||||
|
||||
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.topUrls instead.. Use `topUrls` instead.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
@@ -501,14 +467,14 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetTopURLsRequest](../../models/operations/gettopurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `request` | [operations.GetTopURLsByClicksDeprecatedRequest](../../models/operations/gettopurlsbyclicksdeprecatedrequest.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)>**
|
||||
**Promise<[operations.GetTopURLsByClicksDeprecatedResponseBody[]](../../models/.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
|
||||
Reference in New Issue
Block a user