dub 0.29.8 → 0.29.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -23
- package/docs/sdks/analytics/README.md +6 -440
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/lib/config.js.map +1 -1
- package/models/components/clicksbrowsers.d.ts +21 -0
- package/models/components/clicksbrowsers.d.ts.map +1 -0
- package/models/components/clicksbrowsers.js +57 -0
- package/models/components/clicksbrowsers.js.map +1 -0
- package/models/components/{clicksbycities.d.ts → clickscities.d.ts} +9 -9
- package/models/components/clickscities.d.ts.map +1 -0
- package/models/components/{clicksbycities.js → clickscities.js} +15 -15
- package/models/components/clickscities.js.map +1 -0
- package/models/components/clickscount.d.ts +16 -0
- package/models/components/clickscount.d.ts.map +1 -0
- package/models/components/clickscount.js +53 -0
- package/models/components/clickscount.js.map +1 -0
- package/models/components/{clicksbycountry.d.ts → clickscountries.d.ts} +5 -5
- package/models/components/{clicksbycountry.d.ts.map → clickscountries.d.ts.map} +1 -1
- package/models/components/{clicksbycountry.js → clickscountries.js} +7 -7
- package/models/components/{clicksbycountry.js.map → clickscountries.js.map} +1 -1
- package/models/components/clicksdevices.d.ts +21 -0
- package/models/components/clicksdevices.d.ts.map +1 -0
- package/models/components/clicksdevices.js +57 -0
- package/models/components/clicksdevices.js.map +1 -0
- package/models/components/clicksos.d.ts +21 -0
- package/models/components/clicksos.d.ts.map +1 -0
- package/models/components/clicksos.js +57 -0
- package/models/components/clicksos.js.map +1 -0
- package/models/components/clicksreferers.d.ts +21 -0
- package/models/components/clicksreferers.d.ts.map +1 -0
- package/models/components/clicksreferers.js +57 -0
- package/models/components/clicksreferers.js.map +1 -0
- package/models/components/clickstimeseries.d.ts +21 -0
- package/models/components/clickstimeseries.d.ts.map +1 -0
- package/models/components/clickstimeseries.js +57 -0
- package/models/components/clickstimeseries.js.map +1 -0
- package/models/components/clickstoplinks.d.ts +53 -0
- package/models/components/clickstoplinks.d.ts.map +1 -0
- package/models/components/clickstoplinks.js +81 -0
- package/models/components/clickstoplinks.js.map +1 -0
- package/models/components/clickstopurls.d.ts +21 -0
- package/models/components/clickstopurls.d.ts.map +1 -0
- package/models/components/clickstopurls.js +57 -0
- package/models/components/clickstopurls.js.map +1 -0
- package/models/components/index.d.ts +30 -2
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +30 -2
- package/models/components/index.js.map +1 -1
- package/models/components/leadsbrowsers.d.ts +21 -0
- package/models/components/leadsbrowsers.d.ts.map +1 -0
- package/models/components/leadsbrowsers.js +57 -0
- package/models/components/leadsbrowsers.js.map +1 -0
- package/models/components/leadscities.d.ts +793 -0
- package/models/components/leadscities.d.ts.map +1 -0
- package/models/components/leadscities.js +322 -0
- package/models/components/leadscities.js.map +1 -0
- package/models/components/leadscount.d.ts +16 -0
- package/models/components/leadscount.d.ts.map +1 -0
- package/models/components/leadscount.js +53 -0
- package/models/components/leadscount.js.map +1 -0
- package/models/components/leadscountries.d.ts +788 -0
- package/models/components/leadscountries.d.ts.map +1 -0
- package/models/components/leadscountries.js +318 -0
- package/models/components/leadscountries.js.map +1 -0
- package/models/components/leadsdevices.d.ts +21 -0
- package/models/components/leadsdevices.d.ts.map +1 -0
- package/models/components/leadsdevices.js +57 -0
- package/models/components/leadsdevices.js.map +1 -0
- package/models/components/leadsos.d.ts +21 -0
- package/models/components/leadsos.d.ts.map +1 -0
- package/models/components/leadsos.js +57 -0
- package/models/components/leadsos.js.map +1 -0
- package/models/components/leadsreferers.d.ts +21 -0
- package/models/components/leadsreferers.d.ts.map +1 -0
- package/models/components/leadsreferers.js +57 -0
- package/models/components/leadsreferers.js.map +1 -0
- package/models/components/leadstimeseries.d.ts +21 -0
- package/models/components/leadstimeseries.d.ts.map +1 -0
- package/models/components/leadstimeseries.js +57 -0
- package/models/components/leadstimeseries.js.map +1 -0
- package/models/components/leadstoplinks.d.ts +53 -0
- package/models/components/leadstoplinks.d.ts.map +1 -0
- package/models/components/leadstoplinks.js +81 -0
- package/models/components/leadstoplinks.js.map +1 -0
- package/models/components/leadstopurls.d.ts +21 -0
- package/models/components/leadstopurls.d.ts.map +1 -0
- package/models/components/leadstopurls.js +57 -0
- package/models/components/leadstopurls.js.map +1 -0
- package/models/components/linkschema.d.ts +10 -0
- package/models/components/linkschema.d.ts.map +1 -1
- package/models/components/linkschema.js +8 -0
- package/models/components/linkschema.js.map +1 -1
- package/models/components/salesbrowsers.d.ts +26 -0
- package/models/components/salesbrowsers.d.ts.map +1 -0
- package/models/components/salesbrowsers.js +61 -0
- package/models/components/salesbrowsers.js.map +1 -0
- package/models/components/salescities.d.ts +798 -0
- package/models/components/salescities.d.ts.map +1 -0
- package/models/components/salescities.js +326 -0
- package/models/components/salescities.js.map +1 -0
- package/models/components/salescount.d.ts +21 -0
- package/models/components/salescount.d.ts.map +1 -0
- package/models/components/salescount.js +57 -0
- package/models/components/salescount.js.map +1 -0
- package/models/components/salescountries.d.ts +793 -0
- package/models/components/{clicksbycities.d.ts.map → salescountries.d.ts.map} +1 -1
- package/models/components/salescountries.js +322 -0
- package/models/components/{clicksbycities.js.map → salescountries.js.map} +1 -1
- package/models/components/salesdevices.d.ts +26 -0
- package/models/components/salesdevices.d.ts.map +1 -0
- package/models/components/salesdevices.js +61 -0
- package/models/components/salesdevices.js.map +1 -0
- package/models/components/salesos.d.ts +26 -0
- package/models/components/salesos.d.ts.map +1 -0
- package/models/components/salesos.js +61 -0
- package/models/components/salesos.js.map +1 -0
- package/models/components/salesreferers.d.ts +26 -0
- package/models/components/salesreferers.d.ts.map +1 -0
- package/models/components/salesreferers.js +61 -0
- package/models/components/salesreferers.js.map +1 -0
- package/models/components/salestimeseries.d.ts +26 -0
- package/models/components/salestimeseries.d.ts.map +1 -0
- package/models/components/salestimeseries.js +61 -0
- package/models/components/salestimeseries.js.map +1 -0
- package/models/components/salestoplinks.d.ts +58 -0
- package/models/components/salestoplinks.d.ts.map +1 -0
- package/models/components/salestoplinks.js +85 -0
- package/models/components/salestoplinks.js.map +1 -0
- package/models/components/salestopurls.d.ts +26 -0
- package/models/components/salestopurls.d.ts.map +1 -0
- package/models/components/salestopurls.js +61 -0
- package/models/components/salestopurls.js.map +1 -0
- package/models/operations/index.d.ts +1 -20
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +1 -20
- package/models/operations/index.js.map +1 -1
- package/models/operations/retrieveanalytics.d.ts +256 -0
- package/models/operations/retrieveanalytics.d.ts.map +1 -0
- package/models/operations/{getclickscount.js → retrieveanalytics.js} +130 -13
- package/models/operations/retrieveanalytics.js.map +1 -0
- package/models/operations/trackcustomer.d.ts +6 -6
- package/models/operations/trackcustomer.d.ts.map +1 -1
- package/models/operations/trackcustomer.js +12 -12
- package/models/operations/trackcustomer.js.map +1 -1
- package/models/operations/tracklead.d.ts +12 -12
- package/models/operations/tracklead.d.ts.map +1 -1
- package/models/operations/tracklead.js +18 -18
- package/models/operations/tracklead.js.map +1 -1
- package/package.json +1 -1
- package/sdk/analytics.d.ts +3 -81
- package/sdk/analytics.d.ts.map +1 -1
- package/sdk/analytics.js +10 -962
- package/sdk/analytics.js.map +1 -1
- package/src/lib/config.ts +2 -2
- package/src/models/components/clicksbrowsers.ts +48 -0
- package/src/models/components/{clicksbycities.ts → clickscities.ts} +11 -11
- package/src/models/components/clickscount.ts +39 -0
- package/src/models/components/{clicksbycountry.ts → clickscountries.ts} +4 -4
- package/src/models/components/clicksdevices.ts +48 -0
- package/src/models/components/clicksos.ts +48 -0
- package/src/models/components/clicksreferers.ts +48 -0
- package/src/models/components/clickstimeseries.ts +48 -0
- package/src/models/components/clickstoplinks.ts +104 -0
- package/src/models/components/clickstopurls.ts +48 -0
- package/src/models/components/index.ts +30 -2
- package/src/models/components/leadsbrowsers.ts +48 -0
- package/src/models/components/leadscities.ts +324 -0
- package/src/models/components/leadscount.ts +39 -0
- package/src/models/components/leadscountries.ts +315 -0
- package/src/models/components/leadsdevices.ts +48 -0
- package/src/models/components/leadsos.ts +48 -0
- package/src/models/components/leadsreferers.ts +48 -0
- package/src/models/components/leadstimeseries.ts +48 -0
- package/src/models/components/leadstoplinks.ts +104 -0
- package/src/models/components/leadstopurls.ts +48 -0
- package/src/models/components/linkschema.ts +18 -0
- package/src/models/components/salesbrowsers.ts +57 -0
- package/src/models/components/salescities.ts +333 -0
- package/src/models/components/salescount.ts +48 -0
- package/src/models/components/salescountries.ts +324 -0
- package/src/models/components/salesdevices.ts +57 -0
- package/src/models/components/salesos.ts +57 -0
- package/src/models/components/salesreferers.ts +57 -0
- package/src/models/components/salestimeseries.ts +57 -0
- package/src/models/components/salestoplinks.ts +113 -0
- package/src/models/components/salestopurls.ts +57 -0
- package/src/models/operations/index.ts +1 -20
- package/src/models/operations/retrieveanalytics.ts +460 -0
- package/src/models/operations/trackcustomer.ts +18 -18
- package/src/models/operations/tracklead.ts +28 -28
- package/src/sdk/analytics.ts +13 -1142
- package/docs/sdks/clicks/README.md +0 -579
- package/models/operations/getbrowsersbyclicks.d.ts +0 -173
- package/models/operations/getbrowsersbyclicks.d.ts.map +0 -1
- package/models/operations/getbrowsersbyclicks.js +0 -189
- package/models/operations/getbrowsersbyclicks.js.map +0 -1
- package/models/operations/getbrowsersbyclicksdeprecated.d.ts +0 -173
- package/models/operations/getbrowsersbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/getbrowsersbyclicksdeprecated.js +0 -189
- package/models/operations/getbrowsersbyclicksdeprecated.js.map +0 -1
- package/models/operations/getcitiesbyclicks.d.ts +0 -154
- package/models/operations/getcitiesbyclicks.d.ts.map +0 -1
- package/models/operations/getcitiesbyclicks.js +0 -163
- package/models/operations/getcitiesbyclicks.js.map +0 -1
- package/models/operations/getcitiesbyclicksdeprecated.d.ts +0 -154
- package/models/operations/getcitiesbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/getcitiesbyclicksdeprecated.js +0 -163
- package/models/operations/getcitiesbyclicksdeprecated.js.map +0 -1
- package/models/operations/getclickscount.d.ts +0 -154
- package/models/operations/getclickscount.d.ts.map +0 -1
- package/models/operations/getclickscount.js.map +0 -1
- package/models/operations/getclickscountdeprecated.d.ts +0 -154
- package/models/operations/getclickscountdeprecated.d.ts.map +0 -1
- package/models/operations/getclickscountdeprecated.js +0 -163
- package/models/operations/getclickscountdeprecated.js.map +0 -1
- package/models/operations/getcountriesbyclicks.d.ts +0 -154
- package/models/operations/getcountriesbyclicks.d.ts.map +0 -1
- package/models/operations/getcountriesbyclicks.js +0 -163
- package/models/operations/getcountriesbyclicks.js.map +0 -1
- package/models/operations/getcountriesbyclicksdeprecated.d.ts +0 -154
- package/models/operations/getcountriesbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/getcountriesbyclicksdeprecated.js +0 -163
- package/models/operations/getcountriesbyclicksdeprecated.js.map +0 -1
- package/models/operations/getdevicesbyclicks.d.ts +0 -173
- package/models/operations/getdevicesbyclicks.d.ts.map +0 -1
- package/models/operations/getdevicesbyclicks.js +0 -189
- package/models/operations/getdevicesbyclicks.js.map +0 -1
- package/models/operations/getdevicesbyclicksdeprecated.d.ts +0 -173
- package/models/operations/getdevicesbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/getdevicesbyclicksdeprecated.js +0 -189
- package/models/operations/getdevicesbyclicksdeprecated.js.map +0 -1
- package/models/operations/getosbyclicks.d.ts +0 -173
- package/models/operations/getosbyclicks.d.ts.map +0 -1
- package/models/operations/getosbyclicks.js +0 -189
- package/models/operations/getosbyclicks.js.map +0 -1
- package/models/operations/getosbyclicksdeprecated.d.ts +0 -173
- package/models/operations/getosbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/getosbyclicksdeprecated.js +0 -189
- package/models/operations/getosbyclicksdeprecated.js.map +0 -1
- package/models/operations/getreferersbyclicks.d.ts +0 -173
- package/models/operations/getreferersbyclicks.d.ts.map +0 -1
- package/models/operations/getreferersbyclicks.js +0 -189
- package/models/operations/getreferersbyclicks.js.map +0 -1
- package/models/operations/getreferersbyclicksdeprecated.d.ts +0 -173
- package/models/operations/getreferersbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/getreferersbyclicksdeprecated.js +0 -189
- package/models/operations/getreferersbyclicksdeprecated.js.map +0 -1
- package/models/operations/gettimeseriesbyclicks.d.ts +0 -173
- package/models/operations/gettimeseriesbyclicks.d.ts.map +0 -1
- package/models/operations/gettimeseriesbyclicks.js +0 -189
- package/models/operations/gettimeseriesbyclicks.js.map +0 -1
- package/models/operations/gettimeseriesbyclicksdeprecated.d.ts +0 -173
- package/models/operations/gettimeseriesbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/gettimeseriesbyclicksdeprecated.js +0 -189
- package/models/operations/gettimeseriesbyclicksdeprecated.js.map +0 -1
- package/models/operations/gettoplinksbyclicks.d.ts +0 -173
- package/models/operations/gettoplinksbyclicks.d.ts.map +0 -1
- package/models/operations/gettoplinksbyclicks.js +0 -189
- package/models/operations/gettoplinksbyclicks.js.map +0 -1
- package/models/operations/gettoplinksbyclicksdeprecated.d.ts +0 -173
- package/models/operations/gettoplinksbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/gettoplinksbyclicksdeprecated.js +0 -189
- package/models/operations/gettoplinksbyclicksdeprecated.js.map +0 -1
- package/models/operations/gettopurlsbyclicks.d.ts +0 -173
- package/models/operations/gettopurlsbyclicks.d.ts.map +0 -1
- package/models/operations/gettopurlsbyclicks.js +0 -189
- package/models/operations/gettopurlsbyclicks.js.map +0 -1
- package/models/operations/gettopurlsbyclicksdeprecated.d.ts +0 -173
- package/models/operations/gettopurlsbyclicksdeprecated.d.ts.map +0 -1
- package/models/operations/gettopurlsbyclicksdeprecated.js +0 -189
- package/models/operations/gettopurlsbyclicksdeprecated.js.map +0 -1
- package/sdk/clicks.d.ts +0 -88
- package/sdk/clicks.d.ts.map +0 -1
- package/sdk/clicks.js +0 -1352
- package/sdk/clicks.js.map +0 -1
- package/src/models/operations/getbrowsersbyclicks.ts +0 -299
- package/src/models/operations/getbrowsersbyclicksdeprecated.ts +0 -318
- package/src/models/operations/getcitiesbyclicks.ts +0 -251
- package/src/models/operations/getcitiesbyclicksdeprecated.ts +0 -267
- package/src/models/operations/getclickscount.ts +0 -249
- package/src/models/operations/getclickscountdeprecated.ts +0 -261
- package/src/models/operations/getcountriesbyclicks.ts +0 -251
- package/src/models/operations/getcountriesbyclicksdeprecated.ts +0 -267
- package/src/models/operations/getdevicesbyclicks.ts +0 -295
- package/src/models/operations/getdevicesbyclicksdeprecated.ts +0 -318
- package/src/models/operations/getosbyclicks.ts +0 -292
- package/src/models/operations/getosbyclicksdeprecated.ts +0 -304
- package/src/models/operations/getreferersbyclicks.ts +0 -299
- package/src/models/operations/getreferersbyclicksdeprecated.ts +0 -318
- package/src/models/operations/gettimeseriesbyclicks.ts +0 -292
- package/src/models/operations/gettimeseriesbyclicksdeprecated.ts +0 -318
- package/src/models/operations/gettoplinksbyclicks.ts +0 -299
- package/src/models/operations/gettoplinksbyclicksdeprecated.ts +0 -318
- package/src/models/operations/gettopurlsbyclicks.ts +0 -295
- package/src/models/operations/gettopurlsbyclicksdeprecated.ts +0 -318
- package/src/sdk/clicks.ts +0 -1540
package/README.md
CHANGED
|
@@ -103,29 +103,7 @@ run();
|
|
|
103
103
|
|
|
104
104
|
### [analytics](docs/sdks/analytics/README.md)
|
|
105
105
|
|
|
106
|
-
* [
|
|
107
|
-
* [~~country~~](docs/sdks/analytics/README.md#country) - Retrieve top countries by clicks :warning: **Deprecated** Use `countries` instead.
|
|
108
|
-
* [~~city~~](docs/sdks/analytics/README.md#city) - Retrieve top cities by clicks :warning: **Deprecated** Use `cities` instead.
|
|
109
|
-
* [~~device~~](docs/sdks/analytics/README.md#device) - Retrieve top devices by clicks :warning: **Deprecated** Use `devices` instead.
|
|
110
|
-
* [~~browser~~](docs/sdks/analytics/README.md#browser) - Retrieve top browsers by clicks :warning: **Deprecated** Use `browsers` instead.
|
|
111
|
-
* [~~os~~](docs/sdks/analytics/README.md#os) - Retrieve top OS by clicks :warning: **Deprecated** Use `os` instead.
|
|
112
|
-
* [~~referer~~](docs/sdks/analytics/README.md#referer) - Retrieve top referers by clicks :warning: **Deprecated** Use `referers` instead.
|
|
113
|
-
* [~~topLinks~~](docs/sdks/analytics/README.md#toplinks) - Retrieve top links by clicks :warning: **Deprecated** Use `topLinks` instead.
|
|
114
|
-
* [~~topUrls~~](docs/sdks/analytics/README.md#topurls) - Retrieve top URLs by clicks :warning: **Deprecated** Use `topUrls` instead.
|
|
115
|
-
|
|
116
|
-
### [analytics.clicks](docs/sdks/clicks/README.md)
|
|
117
|
-
|
|
118
|
-
* [count](docs/sdks/clicks/README.md#count) - Retrieve the total clicks count
|
|
119
|
-
* [timeseries](docs/sdks/clicks/README.md#timeseries) - Retrieve timeseries click analytics
|
|
120
|
-
* [countries](docs/sdks/clicks/README.md#countries) - Retrieve top countries by clicks
|
|
121
|
-
* [cities](docs/sdks/clicks/README.md#cities) - Retrieve top cities by clicks
|
|
122
|
-
* [devices](docs/sdks/clicks/README.md#devices) - Retrieve top devices by clicks
|
|
123
|
-
* [browsers](docs/sdks/clicks/README.md#browsers) - Retrieve top browsers by clicks
|
|
124
|
-
* [os](docs/sdks/clicks/README.md#os) - Retrieve top OS by clicks
|
|
125
|
-
* [referers](docs/sdks/clicks/README.md#referers) - Retrieve top referers by clicks
|
|
126
|
-
* [topLinks](docs/sdks/clicks/README.md#toplinks) - Retrieve top links by clicks
|
|
127
|
-
* [topUrls](docs/sdks/clicks/README.md#topurls) - Retrieve top URLs by clicks
|
|
128
|
-
* [~~getClicksCountDeprecated~~](docs/sdks/clicks/README.md#getclickscountdeprecated) - Retrieve the total clicks count :warning: **Deprecated** Use `count` instead.
|
|
106
|
+
* [retrieve](docs/sdks/analytics/README.md#retrieve) - Retrieve analytics for a link, a domain, or the authenticated workspace.
|
|
129
107
|
|
|
130
108
|
### [workspaces](docs/sdks/workspaces/README.md)
|
|
131
109
|
|
|
@@ -3,445 +3,11 @@
|
|
|
3
3
|
|
|
4
4
|
### Available Operations
|
|
5
5
|
|
|
6
|
-
* [
|
|
7
|
-
* [~~country~~](#country) - Retrieve top countries by clicks :warning: **Deprecated** Use `countries` instead.
|
|
8
|
-
* [~~city~~](#city) - Retrieve top cities by clicks :warning: **Deprecated** Use `cities` instead.
|
|
9
|
-
* [~~device~~](#device) - Retrieve top devices by clicks :warning: **Deprecated** Use `devices` instead.
|
|
10
|
-
* [~~browser~~](#browser) - Retrieve top browsers by clicks :warning: **Deprecated** Use `browsers` instead.
|
|
11
|
-
* [~~os~~](#os) - Retrieve top OS by clicks :warning: **Deprecated** Use `os` instead.
|
|
12
|
-
* [~~referer~~](#referer) - Retrieve top referers by clicks :warning: **Deprecated** Use `referers` instead.
|
|
13
|
-
* [~~topLinks~~](#toplinks) - Retrieve top links by clicks :warning: **Deprecated** Use `topLinks` instead.
|
|
14
|
-
* [~~topUrls~~](#topurls) - Retrieve top URLs by clicks :warning: **Deprecated** Use `topUrls` instead.
|
|
6
|
+
* [retrieve](#retrieve) - Retrieve analytics for a link, a domain, or the authenticated workspace.
|
|
15
7
|
|
|
16
|
-
##
|
|
8
|
+
## retrieve
|
|
17
9
|
|
|
18
|
-
Retrieve
|
|
19
|
-
|
|
20
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.timeseries instead.. Use `timeseries` instead.
|
|
21
|
-
|
|
22
|
-
### Example Usage
|
|
23
|
-
|
|
24
|
-
```typescript
|
|
25
|
-
import { Dub } from "dub";
|
|
26
|
-
|
|
27
|
-
const dub = new Dub({
|
|
28
|
-
token: "DUB_API_KEY",
|
|
29
|
-
workspaceId: "<value>",
|
|
30
|
-
});
|
|
31
|
-
|
|
32
|
-
async function run() {
|
|
33
|
-
const result = await dub.analytics.timeseries({});
|
|
34
|
-
|
|
35
|
-
// Handle the result
|
|
36
|
-
console.log(result)
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
run();
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Parameters
|
|
43
|
-
|
|
44
|
-
| Parameter | Type | Required | Description |
|
|
45
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
46
|
-
| `request` | [operations.GetTimeseriesByClicksDeprecatedRequest](../../models/operations/gettimeseriesbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
47
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
48
|
-
| `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. |
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
### Response
|
|
52
|
-
|
|
53
|
-
**Promise\<[operations.GetTimeseriesByClicksDeprecatedResponseBody[]](../../models/.md)\>**
|
|
54
|
-
### Errors
|
|
55
|
-
|
|
56
|
-
| Error Object | Status Code | Content Type |
|
|
57
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
58
|
-
| errors.BadRequest | 400 | application/json |
|
|
59
|
-
| errors.Unauthorized | 401 | application/json |
|
|
60
|
-
| errors.Forbidden | 403 | application/json |
|
|
61
|
-
| errors.NotFound | 404 | application/json |
|
|
62
|
-
| errors.Conflict | 409 | application/json |
|
|
63
|
-
| errors.InviteExpired | 410 | application/json |
|
|
64
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
65
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
66
|
-
| errors.InternalServerError | 500 | application/json |
|
|
67
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
68
|
-
|
|
69
|
-
## ~~country~~
|
|
70
|
-
|
|
71
|
-
Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
|
|
72
|
-
|
|
73
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.countries instead.. Use `countries` instead.
|
|
74
|
-
|
|
75
|
-
### Example Usage
|
|
76
|
-
|
|
77
|
-
```typescript
|
|
78
|
-
import { Dub } from "dub";
|
|
79
|
-
|
|
80
|
-
const dub = new Dub({
|
|
81
|
-
token: "DUB_API_KEY",
|
|
82
|
-
workspaceId: "<value>",
|
|
83
|
-
});
|
|
84
|
-
|
|
85
|
-
async function run() {
|
|
86
|
-
const result = await dub.analytics.country({});
|
|
87
|
-
|
|
88
|
-
// Handle the result
|
|
89
|
-
console.log(result)
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
run();
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
### Parameters
|
|
96
|
-
|
|
97
|
-
| Parameter | Type | Required | Description |
|
|
98
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
99
|
-
| `request` | [operations.GetCountriesByClicksDeprecatedRequest](../../models/operations/getcountriesbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
100
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
101
|
-
| `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. |
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
### Response
|
|
105
|
-
|
|
106
|
-
**Promise\<[components.ClicksByCountry[]](../../models/.md)\>**
|
|
107
|
-
### Errors
|
|
108
|
-
|
|
109
|
-
| Error Object | Status Code | Content Type |
|
|
110
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
111
|
-
| errors.BadRequest | 400 | application/json |
|
|
112
|
-
| errors.Unauthorized | 401 | application/json |
|
|
113
|
-
| errors.Forbidden | 403 | application/json |
|
|
114
|
-
| errors.NotFound | 404 | application/json |
|
|
115
|
-
| errors.Conflict | 409 | application/json |
|
|
116
|
-
| errors.InviteExpired | 410 | application/json |
|
|
117
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
118
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
119
|
-
| errors.InternalServerError | 500 | application/json |
|
|
120
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
121
|
-
|
|
122
|
-
## ~~city~~
|
|
123
|
-
|
|
124
|
-
Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.
|
|
125
|
-
|
|
126
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.cities instead.. Use `cities` instead.
|
|
127
|
-
|
|
128
|
-
### Example Usage
|
|
129
|
-
|
|
130
|
-
```typescript
|
|
131
|
-
import { Dub } from "dub";
|
|
132
|
-
|
|
133
|
-
const dub = new Dub({
|
|
134
|
-
token: "DUB_API_KEY",
|
|
135
|
-
workspaceId: "<value>",
|
|
136
|
-
});
|
|
137
|
-
|
|
138
|
-
async function run() {
|
|
139
|
-
const result = await dub.analytics.city({});
|
|
140
|
-
|
|
141
|
-
// Handle the result
|
|
142
|
-
console.log(result)
|
|
143
|
-
}
|
|
144
|
-
|
|
145
|
-
run();
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
### Parameters
|
|
149
|
-
|
|
150
|
-
| Parameter | Type | Required | Description |
|
|
151
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
152
|
-
| `request` | [operations.GetCitiesByClicksDeprecatedRequest](../../models/operations/getcitiesbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
153
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
154
|
-
| `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. |
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
### Response
|
|
158
|
-
|
|
159
|
-
**Promise\<[components.ClicksByCities[]](../../models/.md)\>**
|
|
160
|
-
### Errors
|
|
161
|
-
|
|
162
|
-
| Error Object | Status Code | Content Type |
|
|
163
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
164
|
-
| errors.BadRequest | 400 | application/json |
|
|
165
|
-
| errors.Unauthorized | 401 | application/json |
|
|
166
|
-
| errors.Forbidden | 403 | application/json |
|
|
167
|
-
| errors.NotFound | 404 | application/json |
|
|
168
|
-
| errors.Conflict | 409 | application/json |
|
|
169
|
-
| errors.InviteExpired | 410 | application/json |
|
|
170
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
171
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
172
|
-
| errors.InternalServerError | 500 | application/json |
|
|
173
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
174
|
-
|
|
175
|
-
## ~~device~~
|
|
176
|
-
|
|
177
|
-
Retrieve the top devices by number of clicks for a link, a domain, or the authenticated workspace.
|
|
178
|
-
|
|
179
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.devices instead.. Use `devices` instead.
|
|
180
|
-
|
|
181
|
-
### Example Usage
|
|
182
|
-
|
|
183
|
-
```typescript
|
|
184
|
-
import { Dub } from "dub";
|
|
185
|
-
|
|
186
|
-
const dub = new Dub({
|
|
187
|
-
token: "DUB_API_KEY",
|
|
188
|
-
workspaceId: "<value>",
|
|
189
|
-
});
|
|
190
|
-
|
|
191
|
-
async function run() {
|
|
192
|
-
const result = await dub.analytics.device({});
|
|
193
|
-
|
|
194
|
-
// Handle the result
|
|
195
|
-
console.log(result)
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
run();
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
### Parameters
|
|
202
|
-
|
|
203
|
-
| Parameter | Type | Required | Description |
|
|
204
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
205
|
-
| `request` | [operations.GetDevicesByClicksDeprecatedRequest](../../models/operations/getdevicesbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
206
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
207
|
-
| `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. |
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
### Response
|
|
211
|
-
|
|
212
|
-
**Promise\<[operations.GetDevicesByClicksDeprecatedResponseBody[]](../../models/.md)\>**
|
|
213
|
-
### Errors
|
|
214
|
-
|
|
215
|
-
| Error Object | Status Code | Content Type |
|
|
216
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
217
|
-
| errors.BadRequest | 400 | application/json |
|
|
218
|
-
| errors.Unauthorized | 401 | application/json |
|
|
219
|
-
| errors.Forbidden | 403 | application/json |
|
|
220
|
-
| errors.NotFound | 404 | application/json |
|
|
221
|
-
| errors.Conflict | 409 | application/json |
|
|
222
|
-
| errors.InviteExpired | 410 | application/json |
|
|
223
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
224
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
225
|
-
| errors.InternalServerError | 500 | application/json |
|
|
226
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
227
|
-
|
|
228
|
-
## ~~browser~~
|
|
229
|
-
|
|
230
|
-
Retrieve the top browsers by number of clicks for a link, a domain, or the authenticated workspace.
|
|
231
|
-
|
|
232
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.browsers instead.. Use `browsers` instead.
|
|
233
|
-
|
|
234
|
-
### Example Usage
|
|
235
|
-
|
|
236
|
-
```typescript
|
|
237
|
-
import { Dub } from "dub";
|
|
238
|
-
|
|
239
|
-
const dub = new Dub({
|
|
240
|
-
token: "DUB_API_KEY",
|
|
241
|
-
workspaceId: "<value>",
|
|
242
|
-
});
|
|
243
|
-
|
|
244
|
-
async function run() {
|
|
245
|
-
const result = await dub.analytics.browser({});
|
|
246
|
-
|
|
247
|
-
// Handle the result
|
|
248
|
-
console.log(result)
|
|
249
|
-
}
|
|
250
|
-
|
|
251
|
-
run();
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
### Parameters
|
|
255
|
-
|
|
256
|
-
| Parameter | Type | Required | Description |
|
|
257
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
258
|
-
| `request` | [operations.GetBrowsersByClicksDeprecatedRequest](../../models/operations/getbrowsersbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
259
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
260
|
-
| `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. |
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
### Response
|
|
264
|
-
|
|
265
|
-
**Promise\<[operations.GetBrowsersByClicksDeprecatedResponseBody[]](../../models/.md)\>**
|
|
266
|
-
### Errors
|
|
267
|
-
|
|
268
|
-
| Error Object | Status Code | Content Type |
|
|
269
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
270
|
-
| errors.BadRequest | 400 | application/json |
|
|
271
|
-
| errors.Unauthorized | 401 | application/json |
|
|
272
|
-
| errors.Forbidden | 403 | application/json |
|
|
273
|
-
| errors.NotFound | 404 | application/json |
|
|
274
|
-
| errors.Conflict | 409 | application/json |
|
|
275
|
-
| errors.InviteExpired | 410 | application/json |
|
|
276
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
277
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
278
|
-
| errors.InternalServerError | 500 | application/json |
|
|
279
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
280
|
-
|
|
281
|
-
## ~~os~~
|
|
282
|
-
|
|
283
|
-
Retrieve the top OS by number of clicks for a link, a domain, or the authenticated workspace.
|
|
284
|
-
|
|
285
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.os instead.. Use `os` instead.
|
|
286
|
-
|
|
287
|
-
### Example Usage
|
|
288
|
-
|
|
289
|
-
```typescript
|
|
290
|
-
import { Dub } from "dub";
|
|
291
|
-
|
|
292
|
-
const dub = new Dub({
|
|
293
|
-
token: "DUB_API_KEY",
|
|
294
|
-
workspaceId: "<value>",
|
|
295
|
-
});
|
|
296
|
-
|
|
297
|
-
async function run() {
|
|
298
|
-
const result = await dub.analytics.os({});
|
|
299
|
-
|
|
300
|
-
// Handle the result
|
|
301
|
-
console.log(result)
|
|
302
|
-
}
|
|
303
|
-
|
|
304
|
-
run();
|
|
305
|
-
```
|
|
306
|
-
|
|
307
|
-
### Parameters
|
|
308
|
-
|
|
309
|
-
| Parameter | Type | Required | Description |
|
|
310
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
311
|
-
| `request` | [operations.GetOSByClicksDeprecatedRequest](../../models/operations/getosbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
312
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
313
|
-
| `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. |
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
### Response
|
|
317
|
-
|
|
318
|
-
**Promise\<[operations.GetOSByClicksDeprecatedResponseBody[]](../../models/.md)\>**
|
|
319
|
-
### Errors
|
|
320
|
-
|
|
321
|
-
| Error Object | Status Code | Content Type |
|
|
322
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
323
|
-
| errors.BadRequest | 400 | application/json |
|
|
324
|
-
| errors.Unauthorized | 401 | application/json |
|
|
325
|
-
| errors.Forbidden | 403 | application/json |
|
|
326
|
-
| errors.NotFound | 404 | application/json |
|
|
327
|
-
| errors.Conflict | 409 | application/json |
|
|
328
|
-
| errors.InviteExpired | 410 | application/json |
|
|
329
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
330
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
331
|
-
| errors.InternalServerError | 500 | application/json |
|
|
332
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
333
|
-
|
|
334
|
-
## ~~referer~~
|
|
335
|
-
|
|
336
|
-
Retrieve the top referers by number of clicks for a link, a domain, or the authenticated workspace.
|
|
337
|
-
|
|
338
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.referers instead.. Use `referers` instead.
|
|
339
|
-
|
|
340
|
-
### Example Usage
|
|
341
|
-
|
|
342
|
-
```typescript
|
|
343
|
-
import { Dub } from "dub";
|
|
344
|
-
|
|
345
|
-
const dub = new Dub({
|
|
346
|
-
token: "DUB_API_KEY",
|
|
347
|
-
workspaceId: "<value>",
|
|
348
|
-
});
|
|
349
|
-
|
|
350
|
-
async function run() {
|
|
351
|
-
const result = await dub.analytics.referer({});
|
|
352
|
-
|
|
353
|
-
// Handle the result
|
|
354
|
-
console.log(result)
|
|
355
|
-
}
|
|
356
|
-
|
|
357
|
-
run();
|
|
358
|
-
```
|
|
359
|
-
|
|
360
|
-
### Parameters
|
|
361
|
-
|
|
362
|
-
| Parameter | Type | Required | Description |
|
|
363
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
364
|
-
| `request` | [operations.GetReferersByClicksDeprecatedRequest](../../models/operations/getreferersbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
365
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
366
|
-
| `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. |
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
### Response
|
|
370
|
-
|
|
371
|
-
**Promise\<[operations.GetReferersByClicksDeprecatedResponseBody[]](../../models/.md)\>**
|
|
372
|
-
### Errors
|
|
373
|
-
|
|
374
|
-
| Error Object | Status Code | Content Type |
|
|
375
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
376
|
-
| errors.BadRequest | 400 | application/json |
|
|
377
|
-
| errors.Unauthorized | 401 | application/json |
|
|
378
|
-
| errors.Forbidden | 403 | application/json |
|
|
379
|
-
| errors.NotFound | 404 | application/json |
|
|
380
|
-
| errors.Conflict | 409 | application/json |
|
|
381
|
-
| errors.InviteExpired | 410 | application/json |
|
|
382
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
383
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
384
|
-
| errors.InternalServerError | 500 | application/json |
|
|
385
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
386
|
-
|
|
387
|
-
## ~~topLinks~~
|
|
388
|
-
|
|
389
|
-
Retrieve the top links by number of clicks for a domain or the authenticated workspace.
|
|
390
|
-
|
|
391
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.topLinks instead.. Use `topLinks` instead.
|
|
392
|
-
|
|
393
|
-
### Example Usage
|
|
394
|
-
|
|
395
|
-
```typescript
|
|
396
|
-
import { Dub } from "dub";
|
|
397
|
-
|
|
398
|
-
const dub = new Dub({
|
|
399
|
-
token: "DUB_API_KEY",
|
|
400
|
-
workspaceId: "<value>",
|
|
401
|
-
});
|
|
402
|
-
|
|
403
|
-
async function run() {
|
|
404
|
-
const result = await dub.analytics.topLinks({});
|
|
405
|
-
|
|
406
|
-
// Handle the result
|
|
407
|
-
console.log(result)
|
|
408
|
-
}
|
|
409
|
-
|
|
410
|
-
run();
|
|
411
|
-
```
|
|
412
|
-
|
|
413
|
-
### Parameters
|
|
414
|
-
|
|
415
|
-
| Parameter | Type | Required | Description |
|
|
416
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
417
|
-
| `request` | [operations.GetTopLinksByClicksDeprecatedRequest](../../models/operations/gettoplinksbyclicksdeprecatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
418
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
419
|
-
| `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. |
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
### Response
|
|
423
|
-
|
|
424
|
-
**Promise\<[operations.GetTopLinksByClicksDeprecatedResponseBody[]](../../models/.md)\>**
|
|
425
|
-
### Errors
|
|
426
|
-
|
|
427
|
-
| Error Object | Status Code | Content Type |
|
|
428
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
429
|
-
| errors.BadRequest | 400 | application/json |
|
|
430
|
-
| errors.Unauthorized | 401 | application/json |
|
|
431
|
-
| errors.Forbidden | 403 | application/json |
|
|
432
|
-
| errors.NotFound | 404 | application/json |
|
|
433
|
-
| errors.Conflict | 409 | application/json |
|
|
434
|
-
| errors.InviteExpired | 410 | application/json |
|
|
435
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
436
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
437
|
-
| errors.InternalServerError | 500 | application/json |
|
|
438
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
439
|
-
|
|
440
|
-
## ~~topUrls~~
|
|
441
|
-
|
|
442
|
-
Retrieve the top URLs by number of clicks for a given short link.
|
|
443
|
-
|
|
444
|
-
> :warning: **DEPRECATED**: This method is deprecated. Use dub.analytics.clicks.topUrls instead.. Use `topUrls` instead.
|
|
10
|
+
Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the `event` and `type` query parameters.
|
|
445
11
|
|
|
446
12
|
### Example Usage
|
|
447
13
|
|
|
@@ -454,7 +20,7 @@ const dub = new Dub({
|
|
|
454
20
|
});
|
|
455
21
|
|
|
456
22
|
async function run() {
|
|
457
|
-
const result = await dub.analytics.
|
|
23
|
+
const result = await dub.analytics.retrieve({});
|
|
458
24
|
|
|
459
25
|
// Handle the result
|
|
460
26
|
console.log(result)
|
|
@@ -467,14 +33,14 @@ run();
|
|
|
467
33
|
|
|
468
34
|
| Parameter | Type | Required | Description |
|
|
469
35
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
470
|
-
| `request` | [operations.
|
|
36
|
+
| `request` | [operations.RetrieveAnalyticsRequest](../../models/operations/retrieveanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
471
37
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
472
38
|
| `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. |
|
|
473
39
|
|
|
474
40
|
|
|
475
41
|
### Response
|
|
476
42
|
|
|
477
|
-
**Promise\<[operations.
|
|
43
|
+
**Promise\<[operations.RetrieveAnalyticsResponseBody](../../models/operations/retrieveanalyticsresponsebody.md)\>**
|
|
478
44
|
### Errors
|
|
479
45
|
|
|
480
46
|
| Error Object | Status Code | Content Type |
|
package/lib/config.d.ts
CHANGED
|
@@ -32,8 +32,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
|
|
|
32
32
|
export declare const SDK_METADATA: {
|
|
33
33
|
readonly language: "typescript";
|
|
34
34
|
readonly openapiDocVersion: "0.0.1";
|
|
35
|
-
readonly sdkVersion: "0.29.
|
|
35
|
+
readonly sdkVersion: "0.29.10";
|
|
36
36
|
readonly genVersion: "2.338.1";
|
|
37
|
-
readonly userAgent: "speakeasy-sdk/typescript 0.29.
|
|
37
|
+
readonly userAgent: "speakeasy-sdk/typescript 0.29.10 2.338.1 0.0.1 dub";
|
|
38
38
|
};
|
|
39
39
|
//# sourceMappingURL=config.d.ts.map
|
package/lib/config.js
CHANGED
|
@@ -32,8 +32,8 @@ exports.serverURLFromOptions = serverURLFromOptions;
|
|
|
32
32
|
exports.SDK_METADATA = {
|
|
33
33
|
language: "typescript",
|
|
34
34
|
openapiDocVersion: "0.0.1",
|
|
35
|
-
sdkVersion: "0.29.
|
|
35
|
+
sdkVersion: "0.29.10",
|
|
36
36
|
genVersion: "2.338.1",
|
|
37
|
-
userAgent: "speakeasy-sdk/typescript 0.29.
|
|
37
|
+
userAgent: "speakeasy-sdk/typescript 0.29.10 2.338.1 0.0.1 dub",
|
|
38
38
|
};
|
|
39
39
|
//# sourceMappingURL=config.js.map
|
package/lib/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/lib/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAIH,+BAA2C;AAE3C;;GAEG;AACU,QAAA,UAAU,GAAG;IACtB;;OAEG;IACH,oBAAoB;CACd,CAAC;AA8BX,SAAgB,oBAAoB,CAAC,OAAmB;;IACpD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,kBAAU,CAAC,MAAM,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,SAAS,GAAG,kBAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,gBAAU,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACtB,CAAC;AAfD,oDAeC;AAEY,QAAA,YAAY,GAAG;IACxB,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,OAAO;IAC1B,UAAU,EAAE,
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/lib/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAIH,+BAA2C;AAE3C;;GAEG;AACU,QAAA,UAAU,GAAG;IACtB;;OAEG;IACH,oBAAoB;CACd,CAAC;AA8BX,SAAgB,oBAAoB,CAAC,OAAmB;;IACpD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,kBAAU,CAAC,MAAM,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,SAAS,GAAG,kBAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,gBAAU,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACtB,CAAC;AAfD,oDAeC;AAEY,QAAA,YAAY,GAAG;IACxB,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,OAAO;IAC1B,UAAU,EAAE,SAAS;IACrB,UAAU,EAAE,SAAS;IACrB,SAAS,EAAE,oDAAoD;CACzD,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
export type ClicksBrowsers = {
|
|
3
|
+
/**
|
|
4
|
+
* The name of the browser
|
|
5
|
+
*/
|
|
6
|
+
browser: string;
|
|
7
|
+
/**
|
|
8
|
+
* The number of clicks from this browser
|
|
9
|
+
*/
|
|
10
|
+
clicks: number;
|
|
11
|
+
};
|
|
12
|
+
/** @internal */
|
|
13
|
+
export declare namespace ClicksBrowsers$ {
|
|
14
|
+
const inboundSchema: z.ZodType<ClicksBrowsers, z.ZodTypeDef, unknown>;
|
|
15
|
+
type Outbound = {
|
|
16
|
+
browser: string;
|
|
17
|
+
clicks: number;
|
|
18
|
+
};
|
|
19
|
+
const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ClicksBrowsers>;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=clicksbrowsers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"clicksbrowsers.d.ts","sourceRoot":"","sources":["../../src/models/components/clicksbrowsers.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,MAAM,cAAc,GAAG;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,yBAAiB,eAAe,CAAC;IACtB,MAAM,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAUrE,CAAC;IAEP,KAAY,QAAQ,GAAG;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;IAEK,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,EAAE,cAAc,CAUvE,CAAC;CACV"}
|