LukeParke/dub-node
1
0
Fork 0
mirror of https://github.com/LukeHagar/dub-node.git synced 2025-12-07 12:27:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.292.0

Browse Source
This commit is contained in:
speakeasybot
2024-05-16 10:23:18 +00:00
parent 0158d5818a
commit 0d3ca63c0f
163 changed files with 15201 additions and 3981 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
.speakeasy/gen.lock
View File

@@ -1,12 +1,12 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: f28179cc-ef59-426d-9e85-60cec22fc642 id: f28179cc-ef59-426d-9e85-60cec22fc642
management: management:
docChecksum: 98ca9bc4e949829ec5b766834b0ad8c5 docChecksum: 61ca2a4d60218732e7611140e6caf8d9
docVersion: 0.0.1 docVersion: 0.0.1
speakeasyVersion: 1.286.0 speakeasyVersion: 1.292.0
generationVersion: 2.326.3 generationVersion: 2.332.4
releaseVersion: 0.29.1 releaseVersion: 0.29.2
configChecksum: 6f6d30c5a12a247a1c1897cfaf975279 configChecksum: d735362927204881510a6a6042f5e824
repoURL: https://github.com/dubinc/dub-node.git repoURL: https://github.com/dubinc/dub-node.git
installationURL: https://github.com/dubinc/dub-node installationURL: https://github.com/dubinc/dub-node
published: true published: true
@@ -14,7 +14,7 @@ features:
typescript: typescript:
additionalDependencies: 0.1.0 additionalDependencies: 0.1.0
constsAndDefaults: 0.1.5 constsAndDefaults: 0.1.5
core: 3.9.3 core: 3.9.4
deprecations: 2.81.1 deprecations: 2.81.1
examples: 2.81.4 examples: 2.81.4
flattening: 2.81.1 flattening: 2.81.1
@@ -32,6 +32,7 @@ features:
generatedFiles: generatedFiles:
- src/sdk/links.ts - src/sdk/links.ts
- src/sdk/qrcodes.ts - src/sdk/qrcodes.ts
- src/sdk/clicks.ts
- src/sdk/analytics.ts - src/sdk/analytics.ts
- src/sdk/workspaces.ts - src/sdk/workspaces.ts
- src/sdk/tags.ts - src/sdk/tags.ts
@@ -56,6 +57,7 @@ generatedFiles:
- src/models/errors/sdkerror.ts - src/models/errors/sdkerror.ts
- src/models/errors/sdkvalidationerror.ts - src/models/errors/sdkvalidationerror.ts
- src/types/blobs.ts - src/types/blobs.ts
- src/types/enums.ts
- src/types/index.ts - src/types/index.ts
- src/types/operations.ts - src/types/operations.ts
- src/types/rfcdate.ts - src/types/rfcdate.ts
@@ -83,16 +85,26 @@ generatedFiles:
- src/models/operations/bulkcreatelinks.ts - src/models/operations/bulkcreatelinks.ts
- src/models/operations/upsertlink.ts - src/models/operations/upsertlink.ts
- src/models/operations/getqrcode.ts - src/models/operations/getqrcode.ts
- src/models/operations/getclicksanalytics.ts - src/models/operations/gettimeseriesbyclicksdeprecated.ts
- src/models/operations/gettimeseriesanalytics.ts - src/models/operations/getcountriesbyclicksdeprecated.ts
- src/models/operations/getcountryanalytics.ts - src/models/operations/getcitiesbyclicksdeprecated.ts
- src/models/operations/getcityanalytics.ts - src/models/operations/getdevicesbyclicksdeprecated.ts
- src/models/operations/getdeviceanalytics.ts - src/models/operations/getbrowsersbyclicksdeprecated.ts
- src/models/operations/getbrowseranalytics.ts - src/models/operations/getosbyclicksdeprecated.ts
- src/models/operations/getosanalytics.ts - src/models/operations/getreferersbyclicksdeprecated.ts
- src/models/operations/getrefereranalytics.ts - src/models/operations/gettoplinksbyclicksdeprecated.ts
- src/models/operations/gettoplinks.ts - src/models/operations/gettopurlsbyclicksdeprecated.ts
- src/models/operations/gettopurls.ts - src/models/operations/getclickscount.ts
- src/models/operations/gettimeseriesbyclicks.ts
- src/models/operations/getcountriesbyclicks.ts
- src/models/operations/getcitiesbyclicks.ts
- src/models/operations/getdevicesbyclicks.ts
- src/models/operations/getbrowsersbyclicks.ts
- src/models/operations/getosbyclicks.ts
- src/models/operations/getreferersbyclicks.ts
- src/models/operations/gettoplinksbyclicks.ts
- src/models/operations/gettopurlsbyclicks.ts
- src/models/operations/getclickscountdeprecated.ts
- src/models/operations/createworkspace.ts - src/models/operations/createworkspace.ts
- src/models/operations/getworkspace.ts - src/models/operations/getworkspace.ts
- src/models/operations/gettags.ts - src/models/operations/gettags.ts
@@ -178,47 +190,88 @@ generatedFiles:
- docs/models/operations/upsertlinkrequestbody.md - docs/models/operations/upsertlinkrequestbody.md
- docs/models/operations/level.md - docs/models/operations/level.md
- docs/models/operations/getqrcoderequest.md - docs/models/operations/getqrcoderequest.md
- docs/models/operations/gettimeseriesbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/gettimeseriesbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/gettimeseriesbyclicksdeprecatedrequest.md
- docs/models/operations/gettimeseriesbyclicksdeprecatedresponsebody.md
- docs/models/operations/getcountriesbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/getcountriesbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/getcountriesbyclicksdeprecatedrequest.md
- docs/models/operations/getcountriesbyclicksdeprecatedcountry.md
- docs/models/operations/getcountriesbyclicksdeprecatedresponsebody.md
- docs/models/operations/getcitiesbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/getcitiesbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/getcitiesbyclicksdeprecatedrequest.md
- docs/models/operations/getcitiesbyclicksdeprecatedcountry.md
- docs/models/operations/getcitiesbyclicksdeprecatedresponsebody.md
- docs/models/operations/getdevicesbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/getdevicesbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/getdevicesbyclicksdeprecatedrequest.md
- docs/models/operations/getdevicesbyclicksdeprecatedresponsebody.md
- docs/models/operations/getbrowsersbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/getbrowsersbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/getbrowsersbyclicksdeprecatedrequest.md
- docs/models/operations/getbrowsersbyclicksdeprecatedresponsebody.md
- docs/models/operations/getosbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/getosbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/getosbyclicksdeprecatedrequest.md
- docs/models/operations/getosbyclicksdeprecatedresponsebody.md
- docs/models/operations/getreferersbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/getreferersbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/getreferersbyclicksdeprecatedrequest.md
- docs/models/operations/getreferersbyclicksdeprecatedresponsebody.md
- docs/models/operations/gettoplinksbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/gettoplinksbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/gettoplinksbyclicksdeprecatedrequest.md
- docs/models/operations/gettoplinksbyclicksdeprecatedresponsebody.md
- docs/models/operations/gettopurlsbyclicksdeprecatedqueryparaminterval.md
- docs/models/operations/gettopurlsbyclicksdeprecatedqueryparamcountry.md
- docs/models/operations/gettopurlsbyclicksdeprecatedrequest.md
- docs/models/operations/gettopurlsbyclicksdeprecatedresponsebody.md
- docs/models/operations/interval.md - docs/models/operations/interval.md
- docs/models/operations/country.md - docs/models/operations/country.md
- docs/models/operations/getclicksanalyticsrequest.md - docs/models/operations/getclickscountrequest.md
- docs/models/operations/queryparaminterval.md - docs/models/operations/queryparaminterval.md
- docs/models/operations/queryparamcountry.md - docs/models/operations/queryparamcountry.md
- docs/models/operations/gettimeseriesanalyticsrequest.md - docs/models/operations/gettimeseriesbyclicksrequest.md
- docs/models/operations/responsebody.md - docs/models/operations/responsebody.md
- docs/models/operations/getcountryanalyticsqueryparaminterval.md - docs/models/operations/getcountriesbyclicksqueryparaminterval.md
- docs/models/operations/getcountryanalyticsqueryparamcountry.md - docs/models/operations/getcountriesbyclicksqueryparamcountry.md
- docs/models/operations/getcountryanalyticsrequest.md - docs/models/operations/getcountriesbyclicksrequest.md
- docs/models/operations/getcountryanalyticscountry.md - docs/models/operations/getcountriesbyclickscountry.md
- docs/models/operations/getcountryanalyticsresponsebody.md - docs/models/operations/getcountriesbyclicksresponsebody.md
- docs/models/operations/getcityanalyticsqueryparaminterval.md - docs/models/operations/getcitiesbyclicksqueryparaminterval.md
- docs/models/operations/getcityanalyticsqueryparamcountry.md - docs/models/operations/getcitiesbyclicksqueryparamcountry.md
- docs/models/operations/getcityanalyticsrequest.md - docs/models/operations/getcitiesbyclicksrequest.md
- docs/models/operations/getcityanalyticscountry.md - docs/models/operations/getcitiesbyclickscountry.md
- docs/models/operations/getcityanalyticsresponsebody.md - docs/models/operations/getcitiesbyclicksresponsebody.md
- docs/models/operations/getdeviceanalyticsqueryparaminterval.md - docs/models/operations/getdevicesbyclicksqueryparaminterval.md
- docs/models/operations/getdeviceanalyticsqueryparamcountry.md - docs/models/operations/getdevicesbyclicksqueryparamcountry.md
- docs/models/operations/getdeviceanalyticsrequest.md - docs/models/operations/getdevicesbyclicksrequest.md
- docs/models/operations/getdeviceanalyticsresponsebody.md - docs/models/operations/getdevicesbyclicksresponsebody.md
- docs/models/operations/getbrowseranalyticsqueryparaminterval.md - docs/models/operations/getbrowsersbyclicksqueryparaminterval.md
- docs/models/operations/getbrowseranalyticsqueryparamcountry.md - docs/models/operations/getbrowsersbyclicksqueryparamcountry.md
- docs/models/operations/getbrowseranalyticsrequest.md - docs/models/operations/getbrowsersbyclicksrequest.md
- docs/models/operations/getbrowseranalyticsresponsebody.md - docs/models/operations/getbrowsersbyclicksresponsebody.md
- docs/models/operations/getosanalyticsqueryparaminterval.md - docs/models/operations/getosbyclicksqueryparaminterval.md
- docs/models/operations/getosanalyticsqueryparamcountry.md - docs/models/operations/getosbyclicksqueryparamcountry.md
- docs/models/operations/getosanalyticsrequest.md - docs/models/operations/getosbyclicksrequest.md
- docs/models/operations/getosanalyticsresponsebody.md - docs/models/operations/getosbyclicksresponsebody.md
- docs/models/operations/getrefereranalyticsqueryparaminterval.md - docs/models/operations/getreferersbyclicksqueryparaminterval.md
- docs/models/operations/getrefereranalyticsqueryparamcountry.md - docs/models/operations/getreferersbyclicksqueryparamcountry.md
- docs/models/operations/getrefereranalyticsrequest.md - docs/models/operations/getreferersbyclicksrequest.md
- docs/models/operations/getrefereranalyticsresponsebody.md - docs/models/operations/getreferersbyclicksresponsebody.md
- docs/models/operations/gettoplinksqueryparaminterval.md - docs/models/operations/gettoplinksbyclicksqueryparaminterval.md
- docs/models/operations/gettoplinksqueryparamcountry.md - docs/models/operations/gettoplinksbyclicksqueryparamcountry.md
- docs/models/operations/gettoplinksrequest.md - docs/models/operations/gettoplinksbyclicksrequest.md
- docs/models/operations/gettoplinksresponsebody.md - docs/models/operations/gettoplinksbyclicksresponsebody.md
- docs/models/operations/gettopurlsqueryparaminterval.md - docs/models/operations/gettopurlsbyclicksqueryparaminterval.md
- docs/models/operations/gettopurlsqueryparamcountry.md - docs/models/operations/gettopurlsbyclicksqueryparamcountry.md
- docs/models/operations/gettopurlsrequest.md - docs/models/operations/gettopurlsbyclicksrequest.md
- docs/models/operations/gettopurlsresponsebody.md - docs/models/operations/gettopurlsbyclicksresponsebody.md
- docs/models/operations/getclickscountdeprecatedqueryparaminterval.md
- docs/models/operations/getclickscountdeprecatedqueryparamcountry.md
- docs/models/operations/getclickscountdeprecatedrequest.md
- docs/models/operations/createworkspacerequestbody.md - docs/models/operations/createworkspacerequestbody.md
- docs/models/operations/getworkspacerequest.md - docs/models/operations/getworkspacerequest.md
- docs/models/operations/gettagsrequest.md - docs/models/operations/gettagsrequest.md
@@ -241,6 +294,7 @@ generatedFiles:
- docs/sdks/links/README.md - docs/sdks/links/README.md
- docs/sdks/qrcodes/README.md - docs/sdks/qrcodes/README.md
- docs/sdks/analytics/README.md - docs/sdks/analytics/README.md
- docs/sdks/clicks/README.md
- docs/sdks/workspaces/README.md - docs/sdks/workspaces/README.md
- docs/sdks/tags/README.md - docs/sdks/tags/README.md
- docs/sdks/domains/README.md - docs/sdks/domains/README.md

2
.speakeasy/gen.yaml
View File

@@ -12,7 +12,7 @@ generation:
auth: auth:
oAuth2ClientCredentialsEnabled: false oAuth2ClientCredentialsEnabled: false
typescript: typescript:
version: 0.29.1 version: 0.29.2
additionalDependencies: additionalDependencies:
dependencies: {} dependencies: {}
devDependencies: devDependencies:

10
.speakeasy/workflow.lock
View File

@@ -1,9 +1,9 @@
speakeasyVersion: 1.286.0 speakeasyVersion: 1.292.0
sources: sources:
my-first-source: my-first-source:
sourceNamespace: my-first-source sourceNamespace: my-first-source
sourceRevisionDigest: sha256:ad02d35bb4135d56025bfdc45e8bc727dca8d374bb5b2fe4719807a8daa5a00f sourceRevisionDigest: sha256:5942adf6760284067d2ca0359825cf1ef0521c1664f460e4555f0a57ff26350f
sourceBlobDigest: sha256:55f6456f8fe9211e115022e8d60509a48bec957c9d004192c4746749b46ffd89 sourceBlobDigest: sha256:2015f657a172457134c6c072b9a409640d62716b9b36d933e2b35fb44aa65492
tags: tags:
- latest - latest
- main - main
@@ -11,8 +11,8 @@ targets:
my-first-target: my-first-target:
source: my-first-source source: my-first-source
sourceNamespace: my-first-source sourceNamespace: my-first-source
sourceRevisionDigest: sha256:ad02d35bb4135d56025bfdc45e8bc727dca8d374bb5b2fe4719807a8daa5a00f sourceRevisionDigest: sha256:5942adf6760284067d2ca0359825cf1ef0521c1664f460e4555f0a57ff26350f
sourceBlobDigest: sha256:55f6456f8fe9211e115022e8d60509a48bec957c9d004192c4746749b46ffd89 sourceBlobDigest: sha256:2015f657a172457134c6c072b9a409640d62716b9b36d933e2b35fb44aa65492
outLocation: /github/workspace/repo outLocation: /github/workspace/repo
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0

33
README.md
View File

@@ -103,16 +103,29 @@ run();
### [analytics](docs/sdks/analytics/README.md) ### [analytics](docs/sdks/analytics/README.md)
* [clicks](docs/sdks/analytics/README.md#clicks) - Retrieve clicks analytics * [~~timeseries~~](docs/sdks/analytics/README.md#timeseries) - Retrieve timeseries click analytics :warning: **Deprecated** Use `timeseries` instead.
* [timeseries](docs/sdks/analytics/README.md#timeseries) - Retrieve timeseries analytics * [~~country~~](docs/sdks/analytics/README.md#country) - Retrieve top countries by clicks :warning: **Deprecated** Use `countries` instead.
* [countries](docs/sdks/analytics/README.md#countries) - Retrieve country analytics * [~~city~~](docs/sdks/analytics/README.md#city) - Retrieve top cities by clicks :warning: **Deprecated** Use `cities` instead.
* [cities](docs/sdks/analytics/README.md#cities) - Retrieve city analytics * [~~device~~](docs/sdks/analytics/README.md#device) - Retrieve top devices by clicks :warning: **Deprecated** Use `devices` instead.
* [devices](docs/sdks/analytics/README.md#devices) - Retrieve device analytics * [~~browser~~](docs/sdks/analytics/README.md#browser) - Retrieve top browsers by clicks :warning: **Deprecated** Use `browsers` instead.
* [browsers](docs/sdks/analytics/README.md#browsers) - Retrieve browser analytics * [~~os~~](docs/sdks/analytics/README.md#os) - Retrieve top OS by clicks :warning: **Deprecated** Use `os` instead.
* [os](docs/sdks/analytics/README.md#os) - Retrieve OS analytics * [~~referer~~](docs/sdks/analytics/README.md#referer) - Retrieve top referers by clicks :warning: **Deprecated** Use `referers` instead.
* [referers](docs/sdks/analytics/README.md#referers) - Retrieve referer analytics * [~~topLinks~~](docs/sdks/analytics/README.md#toplinks) - Retrieve top links by clicks :warning: **Deprecated** Use `topLinks` instead.
* [topLinks](docs/sdks/analytics/README.md#toplinks) - Retrieve top links * [~~topUrls~~](docs/sdks/analytics/README.md#topurls) - Retrieve top URLs by clicks :warning: **Deprecated** Use `topUrls` instead.
* [topUrls](docs/sdks/analytics/README.md#topurls) - Retrieve top URLs
### [analytics.clicks](docs/sdks/clicks/README.md)
* [count](docs/sdks/clicks/README.md#count) - Retrieve the total clicks count
* [timeseries](docs/sdks/clicks/README.md#timeseries) - Retrieve timeseries click analytics
* [countries](docs/sdks/clicks/README.md#countries) - Retrieve top countries by clicks
* [cities](docs/sdks/clicks/README.md#cities) - Retrieve top cities by clicks
* [devices](docs/sdks/clicks/README.md#devices) - Retrieve top devices by clicks
* [browsers](docs/sdks/clicks/README.md#browsers) - Retrieve top browsers by clicks
* [os](docs/sdks/clicks/README.md#os) - Retrieve top OS by clicks
* [referers](docs/sdks/clicks/README.md#referers) - Retrieve top referers by clicks
* [topLinks](docs/sdks/clicks/README.md#toplinks) - Retrieve top links by clicks
* [topUrls](docs/sdks/clicks/README.md#topurls) - Retrieve top URLs by clicks
* [~~getClicksCountDeprecated~~](docs/sdks/clicks/README.md#getclickscountdeprecated) - Retrieve the total clicks count :warning: **Deprecated** Use `count` instead.
### [workspaces](docs/sdks/workspaces/README.md) ### [workspaces](docs/sdks/workspaces/README.md)

10
RELEASES.md
View File

@@ -267,3 +267,13 @@ Based on:
- [typescript v0.29.1] . - [typescript v0.29.1] .
### Releases ### Releases
- [NPM v0.29.1] https://www.npmjs.com/package/dub/v/0.29.1 - . - [NPM v0.29.1] https://www.npmjs.com/package/dub/v/0.29.1 - .
## 2024-05-16 10:20:56
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.292.0 (2.332.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.29.2] .
### Releases
- [NPM v0.29.2] https://www.npmjs.com/package/dub/v/0.29.2 - .

842
codeSamples.yaml
View File

File diff suppressed because it is too large Load Diff

1
docs/models/components/linkschema.md
View File

@@ -10,6 +10,7 @@
| `key` | *string* | :heavy_check_mark: | The short link slug. If not provided, a random 7-character slug will be generated. | | `key` | *string* | :heavy_check_mark: | The short link slug. If not provided, a random 7-character slug will be generated. |
| `externalId` | *string* | :heavy_check_mark: | This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_check_mark: | This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter. |
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. | | `url` | *string* | :heavy_check_mark: | The destination URL of the short link. |
| `trackConversion` | *boolean* | :heavy_minus_sign: | [BETA] Whether to track conversions for the short link. |
| `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. | | `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. |
| `expiresAt` | *string* | :heavy_check_mark: | The date and time when the short link will expire in ISO-8601 format. | | `expiresAt` | *string* | :heavy_check_mark: | The date and time when the short link will expire in ISO-8601 format. |
| `expiredUrl` | *string* | :heavy_check_mark: | The URL to redirect to when the short link has expired. | | `expiredUrl` | *string* | :heavy_check_mark: | The URL to redirect to when the short link has expired. |

259
docs/models/operations/getbrowsersbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetBrowsersByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getbrowsersbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetBrowsersByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getbrowsersbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetBrowsersByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetBrowsersByClicksDeprecatedQueryParamInterval](../../models/operations/getbrowsersbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetBrowsersByClicksDeprecatedQueryParamCountry](../../models/operations/getbrowsersbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/getbrowsersbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetBrowsersByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `browser` | *string* | :heavy_check_mark: | The name of the browser |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this browser |

2
docs/models/operations/getbrowseranalyticsqueryparamcountry.md → docs/models/operations/getbrowsersbyclicksqueryparamcountry.md
View File

@@ -1,4 +1,4 @@
# GetBrowserAnalyticsQueryParamCountry # GetBrowsersByClicksQueryParamCountry
The country to retrieve analytics for. The country to retrieve analytics for.

17
docs/models/operations/getbrowsersbyclicksqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetBrowsersByClicksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

8
docs/models/operations/getbrowseranalyticsrequest.md → docs/models/operations/getbrowsersbyclicksrequest.md
View File

@@ -1,18 +1,18 @@
# GetBrowserAnalyticsRequest # GetBrowsersByClicksRequest
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. | | `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. | | `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | | `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetBrowserAnalyticsQueryParamInterval](../../models/operations/getbrowseranalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. | | `interval` | [operations.GetBrowsersByClicksQueryParamInterval](../../models/operations/getbrowsersbyclicksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | | `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | | `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetBrowserAnalyticsQueryParamCountry](../../models/operations/getbrowseranalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. | | `country` | [operations.GetBrowsersByClicksQueryParamCountry](../../models/operations/getbrowsersbyclicksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. | | `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. | | `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. | | `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |

2
docs/models/operations/getbrowseranalyticsresponsebody.md → docs/models/operations/getbrowsersbyclicksresponsebody.md
View File

@@ -1,4 +1,4 @@
# GetBrowserAnalyticsResponseBody # GetBrowsersByClicksResponseBody
## Fields ## Fields

2
docs/models/operations/getcityanalyticscountry.md → docs/models/operations/getcitiesbyclickscountry.md
View File

@@ -1,4 +1,4 @@
# GetCityAnalyticsCountry # GetCitiesByClicksCountry
The 2-letter country code of the city: https://d.to/geo The 2-letter country code of the city: https://d.to/geo

259
docs/models/operations/getcitiesbyclicksdeprecatedcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetCitiesByClicksDeprecatedCountry
The 2-letter country code of the city: https://d.to/geo
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

259
docs/models/operations/getcitiesbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetCitiesByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getcitiesbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetCitiesByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getcitiesbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetCitiesByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetCitiesByClicksDeprecatedQueryParamInterval](../../models/operations/getcitiesbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetCitiesByClicksDeprecatedQueryParamCountry](../../models/operations/getcitiesbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

10
docs/models/operations/getcitiesbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetCitiesByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `city` | *string* | :heavy_check_mark: | The name of the city |
| `country` | [operations.GetCitiesByClicksDeprecatedCountry](../../models/operations/getcitiesbyclicksdeprecatedcountry.md) | :heavy_check_mark: | The 2-letter country code of the city: https://d.to/geo |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this city |

2
docs/models/operations/getosanalyticsqueryparamcountry.md → docs/models/operations/getcitiesbyclicksqueryparamcountry.md
View File

@@ -1,4 +1,4 @@
# GetOSAnalyticsQueryParamCountry # GetCitiesByClicksQueryParamCountry
The country to retrieve analytics for. The country to retrieve analytics for.

4
docs/models/operations/getbrowseranalyticsqueryparaminterval.md → docs/models/operations/getcitiesbyclicksqueryparaminterval.md
View File

@@ -1,6 +1,6 @@
# GetBrowserAnalyticsQueryParamInterval # GetCitiesByClicksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values ## Values

8
docs/models/operations/getcityanalyticsrequest.md → docs/models/operations/getcitiesbyclicksrequest.md
View File

@@ -1,18 +1,18 @@
# GetCityAnalyticsRequest # GetCitiesByClicksRequest
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. | | `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. | | `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | | `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetCityAnalyticsQueryParamInterval](../../models/operations/getcityanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. | | `interval` | [operations.GetCitiesByClicksQueryParamInterval](../../models/operations/getcitiesbyclicksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | | `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | | `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetCityAnalyticsQueryParamCountry](../../models/operations/getcityanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. | | `country` | [operations.GetCitiesByClicksQueryParamCountry](../../models/operations/getcitiesbyclicksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. | | `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. | | `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. | | `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |

10
docs/models/operations/getcitiesbyclicksresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetCitiesByClicksResponseBody
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `city` | *string* | :heavy_check_mark: | The name of the city |
| `country` | [operations.GetCitiesByClicksCountry](../../models/operations/getcitiesbyclickscountry.md) | :heavy_check_mark: | The 2-letter country code of the city: https://d.to/geo |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this city |

10
docs/models/operations/getcityanalyticsresponsebody.md
View File

@@ -1,10 +0,0 @@
# GetCityAnalyticsResponseBody
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `city` | *string* | :heavy_check_mark: | The name of the city |
| `country` | [operations.GetCityAnalyticsCountry](../../models/operations/getcityanalyticscountry.md) | :heavy_check_mark: | The 2-letter country code of the city: https://d.to/geo |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this city |

259
docs/models/operations/getclickscountdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetClicksCountDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getclickscountdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetClicksCountDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getclickscountdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetClicksCountDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetClicksCountDeprecatedQueryParamInterval](../../models/operations/getclickscountdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetClicksCountDeprecatedQueryParamCountry](../../models/operations/getclickscountdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

6
docs/models/operations/getclicksanalyticsrequest.md → docs/models/operations/getclickscountrequest.md
View File

@@ -1,15 +1,15 @@
# GetClicksAnalyticsRequest # GetClicksCountRequest
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. | | `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. | | `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | | `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.Interval](../../models/operations/interval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. | | `interval` | [operations.Interval](../../models/operations/interval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | | `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | | `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.Country](../../models/operations/country.md) | :heavy_minus_sign: | The country to retrieve analytics for. | | `country` | [operations.Country](../../models/operations/country.md) | :heavy_minus_sign: | The country to retrieve analytics for. |

2
docs/models/operations/getcountryanalyticscountry.md → docs/models/operations/getcountriesbyclickscountry.md
View File

@@ -1,4 +1,4 @@
# GetCountryAnalyticsCountry # GetCountriesByClicksCountry
The 2-letter country code: https://d.to/geo The 2-letter country code: https://d.to/geo

259
docs/models/operations/getcountriesbyclicksdeprecatedcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetCountriesByClicksDeprecatedCountry
The 2-letter country code: https://d.to/geo
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

259
docs/models/operations/getcountriesbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetCountriesByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getcountriesbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetCountriesByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getcountriesbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetCountriesByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetCountriesByClicksDeprecatedQueryParamInterval](../../models/operations/getcountriesbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetCountriesByClicksDeprecatedQueryParamCountry](../../models/operations/getcountriesbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/getcountriesbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetCountriesByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `country` | [operations.GetCountriesByClicksDeprecatedCountry](../../models/operations/getcountriesbyclicksdeprecatedcountry.md) | :heavy_check_mark: | The 2-letter country code: https://d.to/geo |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this country |

259
docs/models/operations/getcountriesbyclicksqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetCountriesByClicksQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getcountriesbyclicksqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetCountriesByClicksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getcountriesbyclicksrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetCountriesByClicksRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetCountriesByClicksQueryParamInterval](../../models/operations/getcountriesbyclicksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetCountriesByClicksQueryParamCountry](../../models/operations/getcountriesbyclicksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/getcountriesbyclicksresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetCountriesByClicksResponseBody
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `country` | [operations.GetCountriesByClicksCountry](../../models/operations/getcountriesbyclickscountry.md) | :heavy_check_mark: | The 2-letter country code: https://d.to/geo |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this country |

9
docs/models/operations/getcountryanalyticsresponsebody.md
View File

@@ -1,9 +0,0 @@
# GetCountryAnalyticsResponseBody
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `country` | [operations.GetCountryAnalyticsCountry](../../models/operations/getcountryanalyticscountry.md) | :heavy_check_mark: | The 2-letter country code: https://d.to/geo |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this country |

259
docs/models/operations/getdevicesbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetDevicesByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getdevicesbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetDevicesByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getdevicesbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetDevicesByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetDevicesByClicksDeprecatedQueryParamInterval](../../models/operations/getdevicesbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetDevicesByClicksDeprecatedQueryParamCountry](../../models/operations/getdevicesbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/getdevicesbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetDevicesByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| `device` | *string* | :heavy_check_mark: | The name of the device |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this device |

2
docs/models/operations/getcityanalyticsqueryparamcountry.md → docs/models/operations/getdevicesbyclicksqueryparamcountry.md
View File

@@ -1,4 +1,4 @@
# GetCityAnalyticsQueryParamCountry # GetDevicesByClicksQueryParamCountry
The country to retrieve analytics for. The country to retrieve analytics for.

4
docs/models/operations/getcountryanalyticsqueryparaminterval.md → docs/models/operations/getdevicesbyclicksqueryparaminterval.md
View File

@@ -1,6 +1,6 @@
# GetCountryAnalyticsQueryParamInterval # GetDevicesByClicksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values ## Values

8
docs/models/operations/getdeviceanalyticsrequest.md → docs/models/operations/getdevicesbyclicksrequest.md
View File

@@ -1,18 +1,18 @@
# GetDeviceAnalyticsRequest # GetDevicesByClicksRequest
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. | | `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. | | `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | | `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetDeviceAnalyticsQueryParamInterval](../../models/operations/getdeviceanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. | | `interval` | [operations.GetDevicesByClicksQueryParamInterval](../../models/operations/getdevicesbyclicksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | | `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | | `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetDeviceAnalyticsQueryParamCountry](../../models/operations/getdeviceanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. | | `country` | [operations.GetDevicesByClicksQueryParamCountry](../../models/operations/getdevicesbyclicksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. | | `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. | | `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. | | `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |

2
docs/models/operations/getdeviceanalyticsresponsebody.md → docs/models/operations/getdevicesbyclicksresponsebody.md
View File

@@ -1,4 +1,4 @@
# GetDeviceAnalyticsResponseBody # GetDevicesByClicksResponseBody
## Fields ## Fields

17
docs/models/operations/getosanalyticsqueryparaminterval.md
View File

@@ -1,17 +0,0 @@
# GetOSAnalyticsQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

259
docs/models/operations/getosbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetOSByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getosbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetOSByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getosbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetOSByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetOSByClicksDeprecatedQueryParamInterval](../../models/operations/getosbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetOSByClicksDeprecatedQueryParamCountry](../../models/operations/getosbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/getosbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetOSByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `os` | *string* | :heavy_check_mark: | The name of the OS |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this OS |

2
docs/models/operations/gettoplinksqueryparamcountry.md → docs/models/operations/getosbyclicksqueryparamcountry.md
View File

@@ -1,4 +1,4 @@
# GetTopLinksQueryParamCountry # GetOSByClicksQueryParamCountry
The country to retrieve analytics for. The country to retrieve analytics for.

4
docs/models/operations/getcityanalyticsqueryparaminterval.md → docs/models/operations/getosbyclicksqueryparaminterval.md
View File

@@ -1,6 +1,6 @@
# GetCityAnalyticsQueryParamInterval # GetOSByClicksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values ## Values

8
docs/models/operations/gettoplinksrequest.md → docs/models/operations/getosbyclicksrequest.md
View File

@@ -1,18 +1,18 @@
# GetTopLinksRequest # GetOSByClicksRequest
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. | | `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. | | `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | | `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetTopLinksQueryParamInterval](../../models/operations/gettoplinksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. | | `interval` | [operations.GetOSByClicksQueryParamInterval](../../models/operations/getosbyclicksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | | `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | | `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetTopLinksQueryParamCountry](../../models/operations/gettoplinksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. | | `country` | [operations.GetOSByClicksQueryParamCountry](../../models/operations/getosbyclicksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. | | `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. | | `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. | | `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |

2
docs/models/operations/getosanalyticsresponsebody.md → docs/models/operations/getosbyclicksresponsebody.md
View File

@@ -1,4 +1,4 @@
# GetOSAnalyticsResponseBody # GetOSByClicksResponseBody
## Fields ## Fields

259
docs/models/operations/getrefereranalyticsqueryparamcountry.md
View File

@@ -1,259 +0,0 @@
# GetRefererAnalyticsQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getrefereranalyticsqueryparaminterval.md
View File

@@ -1,17 +0,0 @@
# GetRefererAnalyticsQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getrefereranalyticsrequest.md
View File

@@ -1,24 +0,0 @@
# GetRefererAnalyticsRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetRefererAnalyticsQueryParamInterval](../../models/operations/getrefereranalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetRefererAnalyticsQueryParamCountry](../../models/operations/getrefereranalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

259
docs/models/operations/getreferersbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetReferersByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/getreferersbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetReferersByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/getreferersbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetReferersByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetReferersByClicksDeprecatedQueryParamInterval](../../models/operations/getreferersbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetReferersByClicksDeprecatedQueryParamCountry](../../models/operations/getreferersbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/getreferersbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetReferersByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `referer` | *string* | :heavy_check_mark: | The name of the referer. If unknown, this will be `(direct)` |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this referer |

2
docs/models/operations/getcountryanalyticsqueryparamcountry.md → docs/models/operations/getreferersbyclicksqueryparamcountry.md
View File

@@ -1,4 +1,4 @@
# GetCountryAnalyticsQueryParamCountry # GetReferersByClicksQueryParamCountry
The country to retrieve analytics for. The country to retrieve analytics for.

17
docs/models/operations/getreferersbyclicksqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetReferersByClicksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

8
docs/models/operations/getcountryanalyticsrequest.md → docs/models/operations/getreferersbyclicksrequest.md
View File

@@ -1,18 +1,18 @@
# GetCountryAnalyticsRequest # GetReferersByClicksRequest
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. | | `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. | | `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | | `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetCountryAnalyticsQueryParamInterval](../../models/operations/getcountryanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. | | `interval` | [operations.GetReferersByClicksQueryParamInterval](../../models/operations/getreferersbyclicksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | | `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | | `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetCountryAnalyticsQueryParamCountry](../../models/operations/getcountryanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. | | `country` | [operations.GetReferersByClicksQueryParamCountry](../../models/operations/getreferersbyclicksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. | | `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. | | `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. | | `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |

2
docs/models/operations/getrefereranalyticsresponsebody.md → docs/models/operations/getreferersbyclicksresponsebody.md
View File

@@ -1,4 +1,4 @@
# GetRefererAnalyticsResponseBody # GetReferersByClicksResponseBody
## Fields ## Fields

259
docs/models/operations/gettimeseriesbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetTimeseriesByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/gettimeseriesbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetTimeseriesByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/gettimeseriesbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetTimeseriesByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetTimeseriesByClicksDeprecatedQueryParamInterval](../../models/operations/gettimeseriesbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetTimeseriesByClicksDeprecatedQueryParamCountry](../../models/operations/gettimeseriesbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/gettimeseriesbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetTimeseriesByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `start` | *string* | :heavy_check_mark: | The starting timestamp of the interval |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks in the interval |

6
docs/models/operations/gettimeseriesanalyticsrequest.md → docs/models/operations/gettimeseriesbyclicksrequest.md
View File

@@ -1,15 +1,15 @@
# GetTimeseriesAnalyticsRequest # GetTimeseriesByClicksRequest
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. | | `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. | | `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | | `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.QueryParamInterval](../../models/operations/queryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. | | `interval` | [operations.QueryParamInterval](../../models/operations/queryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | | `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | | `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.QueryParamCountry](../../models/operations/queryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. | | `country` | [operations.QueryParamCountry](../../models/operations/queryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |

259
docs/models/operations/gettoplinksbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetTopLinksByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/gettoplinksbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetTopLinksByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/gettoplinksbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetTopLinksByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetTopLinksByClicksDeprecatedQueryParamInterval](../../models/operations/gettoplinksbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetTopLinksByClicksDeprecatedQueryParamCountry](../../models/operations/gettoplinksbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/gettoplinksbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetTopLinksByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `link` | *string* | :heavy_check_mark: | The unique ID of the short link |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this link |

259
docs/models/operations/gettoplinksbyclicksqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetTopLinksByClicksQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/gettoplinksbyclicksqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetTopLinksByClicksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/gettoplinksbyclicksrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetTopLinksByClicksRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetTopLinksByClicksQueryParamInterval](../../models/operations/gettoplinksbyclicksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetTopLinksByClicksQueryParamCountry](../../models/operations/gettoplinksbyclicksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

2
docs/models/operations/gettoplinksresponsebody.md → docs/models/operations/gettoplinksbyclicksresponsebody.md
View File

@@ -1,4 +1,4 @@
# GetTopLinksResponseBody # GetTopLinksByClicksResponseBody
## Fields ## Fields

17
docs/models/operations/gettoplinksqueryparaminterval.md
View File

@@ -1,17 +0,0 @@
# GetTopLinksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

259
docs/models/operations/gettopurlsbyclicksdeprecatedqueryparamcountry.md Normal file
View File

@@ -0,0 +1,259 @@
# GetTopURLsByClicksDeprecatedQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/gettopurlsbyclicksdeprecatedqueryparaminterval.md Normal file
View File

@@ -0,0 +1,17 @@
# GetTopURLsByClicksDeprecatedQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/gettopurlsbyclicksdeprecatedrequest.md Normal file
View File

@@ -0,0 +1,24 @@
# GetTopURLsByClicksDeprecatedRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetTopURLsByClicksDeprecatedQueryParamInterval](../../models/operations/gettopurlsbyclicksdeprecatedqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetTopURLsByClicksDeprecatedQueryParamCountry](../../models/operations/gettopurlsbyclicksdeprecatedqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

9
docs/models/operations/gettopurlsbyclicksdeprecatedresponsebody.md Normal file
View File

@@ -0,0 +1,9 @@
# GetTopURLsByClicksDeprecatedResponseBody
## Fields
| Field | Type | Required | Description |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `url` | *string* | :heavy_check_mark: | The destination URL |
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this URL |

2
docs/models/operations/getdeviceanalyticsqueryparamcountry.md → docs/models/operations/gettopurlsbyclicksqueryparamcountry.md
View File

@@ -1,4 +1,4 @@
# GetDeviceAnalyticsQueryParamCountry # GetTopURLsByClicksQueryParamCountry
The country to retrieve analytics for. The country to retrieve analytics for.

4
docs/models/operations/getdeviceanalyticsqueryparaminterval.md → docs/models/operations/gettopurlsbyclicksqueryparaminterval.md
View File

@@ -1,6 +1,6 @@
# GetDeviceAnalyticsQueryParamInterval # GetTopURLsByClicksQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values ## Values

8
docs/models/operations/getosanalyticsrequest.md → docs/models/operations/gettopurlsbyclicksrequest.md
View File

@@ -1,18 +1,18 @@
# GetOSAnalyticsRequest # GetTopURLsByClicksRequest
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. | | `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. | | `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | | `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. | | `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetOSAnalyticsQueryParamInterval](../../models/operations/getosanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. | | `interval` | [operations.GetTopURLsByClicksQueryParamInterval](../../models/operations/gettopurlsbyclicksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | | `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | | `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetOSAnalyticsQueryParamCountry](../../models/operations/getosanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. | | `country` | [operations.GetTopURLsByClicksQueryParamCountry](../../models/operations/gettopurlsbyclicksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. | | `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. | | `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. | | `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |

2
docs/models/operations/gettopurlsresponsebody.md → docs/models/operations/gettopurlsbyclicksresponsebody.md
View File

@@ -1,4 +1,4 @@
# GetTopURLsResponseBody # GetTopURLsByClicksResponseBody
## Fields ## Fields

259
docs/models/operations/gettopurlsqueryparamcountry.md
View File

@@ -1,259 +0,0 @@
# GetTopURLsQueryParamCountry
The country to retrieve analytics for.
## Values
| Name | Value |
| ----- | ----- |
| `Af` | AF |
| `Al` | AL |
| `Dz` | DZ |
| `As` | AS |
| `Ad` | AD |
| `Ao` | AO |
| `Ai` | AI |
| `Aq` | AQ |
| `Ag` | AG |
| `Ar` | AR |
| `Am` | AM |
| `Aw` | AW |
| `Au` | AU |
| `At` | AT |
| `Az` | AZ |
| `Bs` | BS |
| `Bh` | BH |
| `Bd` | BD |
| `Bb` | BB |
| `By` | BY |
| `Be` | BE |
| `Bz` | BZ |
| `Bj` | BJ |
| `Bm` | BM |
| `Bt` | BT |
| `Bo` | BO |
| `Ba` | BA |
| `Bw` | BW |
| `Bv` | BV |
| `Br` | BR |
| `Io` | IO |
| `Bn` | BN |
| `Bg` | BG |
| `Bf` | BF |
| `Bi` | BI |
| `Kh` | KH |
| `Cm` | CM |
| `Ca` | CA |
| `Cv` | CV |
| `Ky` | KY |
| `Cf` | CF |
| `Td` | TD |
| `Cl` | CL |
| `Cn` | CN |
| `Cx` | CX |
| `Cc` | CC |
| `Co` | CO |
| `Km` | KM |
| `Cg` | CG |
| `Cd` | CD |
| `Ck` | CK |
| `Cr` | CR |
| `Ci` | CI |
| `Hr` | HR |
| `Cu` | CU |
| `Cy` | CY |
| `Cz` | CZ |
| `Dk` | DK |
| `Dj` | DJ |
| `Dm` | DM |
| `Do` | DO |
| `Ec` | EC |
| `Eg` | EG |
| `Sv` | SV |
| `Gq` | GQ |
| `Er` | ER |
| `Ee` | EE |
| `Et` | ET |
| `Fk` | FK |
| `Fo` | FO |
| `Fj` | FJ |
| `Fi` | FI |
| `Fr` | FR |
| `Gf` | GF |
| `Pf` | PF |
| `Tf` | TF |
| `Ga` | GA |
| `Gm` | GM |
| `Ge` | GE |
| `De` | DE |
| `Gh` | GH |
| `Gi` | GI |
| `Gr` | GR |
| `Gl` | GL |
| `Gd` | GD |
| `Gp` | GP |
| `Gu` | GU |
| `Gt` | GT |
| `Gn` | GN |
| `Gw` | GW |
| `Gy` | GY |
| `Ht` | HT |
| `Hm` | HM |
| `Va` | VA |
| `Hn` | HN |
| `Hk` | HK |
| `Hu` | HU |
| `Is` | IS |
| `In` | IN |
| `Id` | ID |
| `Ir` | IR |
| `Iq` | IQ |
| `Ie` | IE |
| `Il` | IL |
| `It` | IT |
| `Jm` | JM |
| `Jp` | JP |
| `Jo` | JO |
| `Kz` | KZ |
| `Ke` | KE |
| `Ki` | KI |
| `Kp` | KP |
| `Kr` | KR |
| `Kw` | KW |
| `Kg` | KG |
| `La` | LA |
| `Lv` | LV |
| `Lb` | LB |
| `Ls` | LS |
| `Lr` | LR |
| `Ly` | LY |
| `Li` | LI |
| `Lt` | LT |
| `Lu` | LU |
| `Mo` | MO |
| `Mg` | MG |
| `Mw` | MW |
| `My` | MY |
| `Mv` | MV |
| `Ml` | ML |
| `Mt` | MT |
| `Mh` | MH |
| `Mq` | MQ |
| `Mr` | MR |
| `Mu` | MU |
| `Yt` | YT |
| `Mx` | MX |
| `Fm` | FM |
| `Md` | MD |
| `Mc` | MC |
| `Mn` | MN |
| `Ms` | MS |
| `Ma` | MA |
| `Mz` | MZ |
| `Mm` | MM |
| `Na` | NA |
| `Nr` | NR |
| `Np` | NP |
| `Nl` | NL |
| `Nc` | NC |
| `Nz` | NZ |
| `Ni` | NI |
| `Ne` | NE |
| `Ng` | NG |
| `Nu` | NU |
| `Nf` | NF |
| `Mk` | MK |
| `Mp` | MP |
| `No` | NO |
| `Om` | OM |
| `Pk` | PK |
| `Pw` | PW |
| `Ps` | PS |
| `Pa` | PA |
| `Pg` | PG |
| `Py` | PY |
| `Pe` | PE |
| `Ph` | PH |
| `Pn` | PN |
| `Pl` | PL |
| `Pt` | PT |
| `Pr` | PR |
| `Qa` | QA |
| `Re` | RE |
| `Ro` | RO |
| `Ru` | RU |
| `Rw` | RW |
| `Sh` | SH |
| `Kn` | KN |
| `Lc` | LC |
| `Pm` | PM |
| `Vc` | VC |
| `Ws` | WS |
| `Sm` | SM |
| `St` | ST |
| `Sa` | SA |
| `Sn` | SN |
| `Sc` | SC |
| `Sl` | SL |
| `Sg` | SG |
| `Sk` | SK |
| `Si` | SI |
| `Sb` | SB |
| `So` | SO |
| `Za` | ZA |
| `Gs` | GS |
| `Es` | ES |
| `Lk` | LK |
| `Sd` | SD |
| `Sr` | SR |
| `Sj` | SJ |
| `Sz` | SZ |
| `Se` | SE |
| `Ch` | CH |
| `Sy` | SY |
| `Tw` | TW |
| `Tj` | TJ |
| `Tz` | TZ |
| `Th` | TH |
| `Tl` | TL |
| `Tg` | TG |
| `Tk` | TK |
| `To` | TO |
| `Tt` | TT |
| `Tn` | TN |
| `Tr` | TR |
| `Tm` | TM |
| `Tc` | TC |
| `Tv` | TV |
| `Ug` | UG |
| `Ua` | UA |
| `Ae` | AE |
| `Gb` | GB |
| `Us` | US |
| `Um` | UM |
| `Uy` | UY |
| `Uz` | UZ |
| `Vu` | VU |
| `Ve` | VE |
| `Vn` | VN |
| `Vg` | VG |
| `Vi` | VI |
| `Wf` | WF |
| `Eh` | EH |
| `Ye` | YE |
| `Zm` | ZM |
| `Zw` | ZW |
| `Ax` | AX |
| `Bq` | BQ |
| `Cw` | CW |
| `Gg` | GG |
| `Im` | IM |
| `Je` | JE |
| `Me` | ME |
| `Bl` | BL |
| `Mf` | MF |
| `Rs` | RS |
| `Sx` | SX |
| `Ss` | SS |
| `Xk` | XK |

17
docs/models/operations/gettopurlsqueryparaminterval.md
View File

@@ -1,17 +0,0 @@
# GetTopURLsQueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end.
## Values
| Name | Value |
| ------------- | ------------- |
| `Oneh` | 1h |
| `TwentyFourh` | 24h |
| `Sevend` | 7d |
| `Thirtyd` | 30d |
| `Ninetyd` | 90d |
| `Ytd` | ytd |
| `Oney` | 1y |
| `All` | all |

24
docs/models/operations/gettopurlsrequest.md
View File

@@ -1,24 +0,0 @@
# GetTopURLsRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. |
| `externalId` | *string* | :heavy_minus_sign: | This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
| `interval` | [operations.GetTopURLsQueryParamInterval](../../models/operations/gettopurlsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. |
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. |
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
| `country` | [operations.GetTopURLsQueryParamCountry](../../models/operations/gettopurlsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |

2
docs/models/operations/interval.md
View File

@@ -1,6 +1,6 @@
# Interval # Interval
The interval to retrieve analytics for. Takes precedence over start and end. The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values ## Values

2
docs/models/operations/queryparaminterval.md
View File

@@ -1,6 +1,6 @@
# QueryParamInterval # QueryParamInterval
The interval to retrieve analytics for. Takes precedence over start and end. The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
## Values ## Values

152
docs/sdks/analytics/README.md
View File

@@ -3,71 +3,21 @@
### Available Operations ### Available Operations
* [clicks](#clicks) - Retrieve clicks analytics * [~~timeseries~~](#timeseries) - Retrieve timeseries click analytics :warning: **Deprecated** Use `timeseries` instead.
* [timeseries](#timeseries) - Retrieve timeseries analytics * [~~country~~](#country) - Retrieve top countries by clicks :warning: **Deprecated** Use `countries` instead.
* [countries](#countries) - Retrieve country analytics * [~~city~~](#city) - Retrieve top cities by clicks :warning: **Deprecated** Use `cities` instead.
* [cities](#cities) - Retrieve city analytics * [~~device~~](#device) - Retrieve top devices by clicks :warning: **Deprecated** Use `devices` instead.
* [devices](#devices) - Retrieve device analytics * [~~browser~~](#browser) - Retrieve top browsers by clicks :warning: **Deprecated** Use `browsers` instead.
* [browsers](#browsers) - Retrieve browser analytics * [~~os~~](#os) - Retrieve top OS by clicks :warning: **Deprecated** Use `os` instead.
* [os](#os) - Retrieve OS analytics * [~~referer~~](#referer) - Retrieve top referers by clicks :warning: **Deprecated** Use `referers` instead.
* [referers](#referers) - Retrieve referer analytics * [~~topLinks~~](#toplinks) - Retrieve top links by clicks :warning: **Deprecated** Use `topLinks` instead.
* [topLinks](#toplinks) - Retrieve top links * [~~topUrls~~](#topurls) - Retrieve top URLs by clicks :warning: **Deprecated** Use `topUrls` instead.
* [topUrls](#topurls) - Retrieve top URLs
## 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 > :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.timeseries instead.. Use `timeseries` instead.
```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 ### Example Usage
@@ -93,14 +43,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.ResponseBody[]](../../models/.md)>** **Promise<[operations.GetTimeseriesByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |
@@ -116,10 +66,12 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## countries ## ~~country~~
Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace. 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 ### Example Usage
```typescript ```typescript
@@ -131,7 +83,7 @@ const dub = new Dub({
}); });
async function run() { async function run() {
const result = await dub.analytics.countries({}); const result = await dub.analytics.country({});
// Handle the result // Handle the result
console.log(result) console.log(result)
@@ -144,14 +96,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.GetCountryAnalyticsResponseBody[]](../../models/.md)>** **Promise<[operations.GetCountriesByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |
@@ -167,10 +119,12 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## cities ## ~~city~~
Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace. 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 ### Example Usage
```typescript ```typescript
@@ -182,7 +136,7 @@ const dub = new Dub({
}); });
async function run() { async function run() {
const result = await dub.analytics.cities({}); const result = await dub.analytics.city({});
// Handle the result // Handle the result
console.log(result) console.log(result)
@@ -195,14 +149,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.GetCityAnalyticsResponseBody[]](../../models/.md)>** **Promise<[operations.GetCitiesByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |
@@ -218,10 +172,12 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## devices ## ~~device~~
Retrieve the top devices by number of clicks for a link, a domain, or the authenticated workspace. 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 ### Example Usage
```typescript ```typescript
@@ -233,7 +189,7 @@ const dub = new Dub({
}); });
async function run() { async function run() {
const result = await dub.analytics.devices({}); const result = await dub.analytics.device({});
// Handle the result // Handle the result
console.log(result) console.log(result)
@@ -246,14 +202,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.GetDeviceAnalyticsResponseBody[]](../../models/.md)>** **Promise<[operations.GetDevicesByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |
@@ -269,10 +225,12 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## browsers ## ~~browser~~
Retrieve the top browsers by number of clicks for a link, a domain, or the authenticated workspace. 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 ### Example Usage
```typescript ```typescript
@@ -284,7 +242,7 @@ const dub = new Dub({
}); });
async function run() { async function run() {
const result = await dub.analytics.browsers({}); const result = await dub.analytics.browser({});
// Handle the result // Handle the result
console.log(result) console.log(result)
@@ -297,14 +255,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.GetBrowserAnalyticsResponseBody[]](../../models/.md)>** **Promise<[operations.GetBrowsersByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |
@@ -320,10 +278,12 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## os ## ~~os~~
Retrieve the top OS by number of clicks for a link, a domain, or the authenticated workspace. 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 ### Example Usage
```typescript ```typescript
@@ -348,14 +308,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.GetOSAnalyticsResponseBody[]](../../models/.md)>** **Promise<[operations.GetOSByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |
@@ -371,10 +331,12 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## referers ## ~~referer~~
Retrieve the top referers by number of clicks for a link, a domain, or the authenticated workspace. 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 ### Example Usage
```typescript ```typescript
@@ -386,7 +348,7 @@ const dub = new Dub({
}); });
async function run() { async function run() {
const result = await dub.analytics.referers({}); const result = await dub.analytics.referer({});
// Handle the result // Handle the result
console.log(result) console.log(result)
@@ -399,14 +361,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.GetRefererAnalyticsResponseBody[]](../../models/.md)>** **Promise<[operations.GetReferersByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |
@@ -422,10 +384,12 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## topLinks ## ~~topLinks~~
Retrieve the top links by number of clicks for a domain or the authenticated workspace. 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 ### Example Usage
```typescript ```typescript
@@ -450,14 +414,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.GetTopLinksResponseBody[]](../../models/.md)>** **Promise<[operations.GetTopLinksByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |
@@ -473,10 +437,12 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## topUrls ## ~~topUrls~~
Retrieve the top URLs by number of clicks for a given short link. 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 ### Example Usage
```typescript ```typescript
@@ -501,14 +467,14 @@ run();
| Parameter | Type | Required | Description | | 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` | 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. | | `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 ### Response
**Promise<[operations.GetTopURLsResponseBody[]](../../models/.md)>** **Promise<[operations.GetTopURLsByClicksDeprecatedResponseBody[]](../../models/.md)>**
### Errors ### Errors
| Error Object | Status Code | Content Type | | Error Object | Status Code | Content Type |

579
docs/sdks/clicks/README.md Normal file
View File

@@ -0,0 +1,579 @@
# Clicks
(*analytics.clicks*)
### Available Operations
* [count](#count) - Retrieve the total clicks count
* [timeseries](#timeseries) - Retrieve timeseries click analytics
* [countries](#countries) - Retrieve top countries by clicks
* [cities](#cities) - Retrieve top cities by clicks
* [devices](#devices) - Retrieve top devices by clicks
* [browsers](#browsers) - Retrieve top browsers by clicks
* [os](#os) - Retrieve top OS by clicks
* [referers](#referers) - Retrieve top referers by clicks
* [topLinks](#toplinks) - Retrieve top links by clicks
* [topUrls](#topurls) - Retrieve top URLs by clicks
* [~~getClicksCountDeprecated~~](#getclickscountdeprecated) - Retrieve the total clicks count :warning: **Deprecated** Use `count` instead.
## count
Retrieve the total 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.count({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetClicksCountRequest](../../models/operations/getclickscountrequest.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 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.timeseries({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetTimeseriesByClicksRequest](../../models/operations/gettimeseriesbyclicksrequest.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.clicks.countries({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetCountriesByClicksRequest](../../models/operations/getcountriesbyclicksrequest.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.GetCountriesByClicksResponseBody[]](../../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.clicks.cities({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetCitiesByClicksRequest](../../models/operations/getcitiesbyclicksrequest.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.GetCitiesByClicksResponseBody[]](../../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.clicks.devices({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetDevicesByClicksRequest](../../models/operations/getdevicesbyclicksrequest.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.GetDevicesByClicksResponseBody[]](../../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.clicks.browsers({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetBrowsersByClicksRequest](../../models/operations/getbrowsersbyclicksrequest.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.GetBrowsersByClicksResponseBody[]](../../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.clicks.os({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetOSByClicksRequest](../../models/operations/getosbyclicksrequest.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.GetOSByClicksResponseBody[]](../../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.clicks.referers({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetReferersByClicksRequest](../../models/operations/getreferersbyclicksrequest.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.GetReferersByClicksResponseBody[]](../../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.clicks.topLinks({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetTopLinksByClicksRequest](../../models/operations/gettoplinksbyclicksrequest.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.GetTopLinksByClicksResponseBody[]](../../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.clicks.topUrls({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetTopURLsByClicksRequest](../../models/operations/gettopurlsbyclicksrequest.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.GetTopURLsByClicksResponseBody[]](../../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 | */* |
## ~~getClicksCountDeprecated~~
Retrieve the total number of clicks for a link, a domain, or the authenticated workspace.
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.count instead.. Use `count` instead.
### 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.getClicksCountDeprecated({});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetClicksCountDeprecatedRequest](../../models/operations/getclickscountdeprecatedrequest.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 | */* |

4
docs/sdks/links/README.md
View File

@@ -271,7 +271,7 @@ run();
## update ## update
Update a link for the authenticated workspace. If there's no change, returns as is. Update a link for the authenticated workspace. If there's no change, returns it as it is.
### Example Usage ### Example Usage
@@ -380,7 +380,7 @@ run();
## upsert ## upsert
Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, returns as is if there's no change, or update it. Otherwise, a new link will be created. Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created.
### Example Usage ### Example Usage

2
jsr.json
View File

@@ -2,7 +2,7 @@
{ {
"name": "dub", "name": "dub",
"version": "0.29.1", "version": "0.29.2",
"exports": { "exports": {
".": "./src/index.ts", ".": "./src/index.ts",
"./models/errors": "./src/models/errors/index.ts", "./models/errors": "./src/models/errors/index.ts",

Some files were not shown because too many files have changed in this diff Show More