mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 12:27:48 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.297.0
This commit is contained in:
speakeasybot
@@ -1,12 +1,12 @@
|
||||
lockVersion: 2.0.0
|
||||
id: f28179cc-ef59-426d-9e85-60cec22fc642
|
||||
management:
|
||||
docChecksum: c82cc79ffda0379ff35a3ee5f8667c0d
|
||||
docChecksum: 6f3206753e886703c723485794073b77
|
||||
docVersion: 0.0.1
|
||||
speakeasyVersion: 1.296.1
|
||||
speakeasyVersion: 1.297.0
|
||||
generationVersion: 2.338.1
|
||||
releaseVersion: 0.29.9
|
||||
configChecksum: 1b24c67caa5adefda06b3a743d0bca5f
|
||||
releaseVersion: 0.29.10
|
||||
configChecksum: 70681a5b78b1bf018371485189a5d1f1
|
||||
repoURL: https://github.com/dubinc/dub-node.git
|
||||
installationURL: https://github.com/dubinc/dub-node
|
||||
published: true
|
||||
@@ -32,7 +32,6 @@ features:
|
||||
generatedFiles:
|
||||
- src/sdk/links.ts
|
||||
- src/sdk/qrcodes.ts
|
||||
- src/sdk/clicks.ts
|
||||
- src/sdk/analytics.ts
|
||||
- src/sdk/workspaces.ts
|
||||
- src/sdk/tags.ts
|
||||
@@ -67,9 +66,37 @@ generatedFiles:
|
||||
- src/models/components/linkschema.ts
|
||||
- src/models/components/tagschema.ts
|
||||
- src/models/components/linkgeotargeting.ts
|
||||
- src/models/components/clickscount.ts
|
||||
- src/models/components/clickstimeseries.ts
|
||||
- src/models/components/clickscountries.ts
|
||||
- src/models/components/clickscities.ts
|
||||
- src/models/components/clicksdevices.ts
|
||||
- src/models/components/clicksbrowsers.ts
|
||||
- src/models/components/clicksos.ts
|
||||
- src/models/components/clicksreferers.ts
|
||||
- src/models/components/clickstoplinks.ts
|
||||
- src/models/components/clickstopurls.ts
|
||||
- src/models/components/leadscount.ts
|
||||
- src/models/components/leadstimeseries.ts
|
||||
- src/models/components/leadscountries.ts
|
||||
- src/models/components/leadscities.ts
|
||||
- src/models/components/leadsdevices.ts
|
||||
- src/models/components/leadsbrowsers.ts
|
||||
- src/models/components/leadsos.ts
|
||||
- src/models/components/leadsreferers.ts
|
||||
- src/models/components/leadstoplinks.ts
|
||||
- src/models/components/leadstopurls.ts
|
||||
- src/models/components/salescount.ts
|
||||
- src/models/components/salestimeseries.ts
|
||||
- src/models/components/salescountries.ts
|
||||
- src/models/components/salescities.ts
|
||||
- src/models/components/salesdevices.ts
|
||||
- src/models/components/salesbrowsers.ts
|
||||
- src/models/components/salesos.ts
|
||||
- src/models/components/salesreferers.ts
|
||||
- src/models/components/salestoplinks.ts
|
||||
- src/models/components/salestopurls.ts
|
||||
- src/models/components/countrycode.ts
|
||||
- src/models/components/clicksbycountry.ts
|
||||
- src/models/components/clicksbycities.ts
|
||||
- src/models/components/workspaceschema.ts
|
||||
- src/models/components/domainschema.ts
|
||||
- src/models/components/security.ts
|
||||
@@ -91,26 +118,7 @@ generatedFiles:
|
||||
- src/models/operations/bulkcreatelinks.ts
|
||||
- src/models/operations/upsertlink.ts
|
||||
- src/models/operations/getqrcode.ts
|
||||
- src/models/operations/gettimeseriesbyclicksdeprecated.ts
|
||||
- src/models/operations/getcountriesbyclicksdeprecated.ts
|
||||
- src/models/operations/getcitiesbyclicksdeprecated.ts
|
||||
- src/models/operations/getdevicesbyclicksdeprecated.ts
|
||||
- src/models/operations/getbrowsersbyclicksdeprecated.ts
|
||||
- src/models/operations/getosbyclicksdeprecated.ts
|
||||
- src/models/operations/getreferersbyclicksdeprecated.ts
|
||||
- src/models/operations/gettoplinksbyclicksdeprecated.ts
|
||||
- src/models/operations/gettopurlsbyclicksdeprecated.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/retrieveanalytics.ts
|
||||
- src/models/operations/createworkspace.ts
|
||||
- src/models/operations/getworkspace.ts
|
||||
- src/models/operations/gettags.ts
|
||||
@@ -133,11 +141,43 @@ generatedFiles:
|
||||
- docs/models/components/color.md
|
||||
- docs/models/components/tagschema.md
|
||||
- docs/models/components/linkgeotargeting.md
|
||||
- docs/models/components/countrycode.md
|
||||
- docs/models/components/clickscount.md
|
||||
- docs/models/components/clickstimeseries.md
|
||||
- docs/models/components/country.md
|
||||
- docs/models/components/clicksbycountry.md
|
||||
- docs/models/components/clicksbycitiescountry.md
|
||||
- docs/models/components/clicksbycities.md
|
||||
- docs/models/components/clickscountries.md
|
||||
- docs/models/components/clickscitiescountry.md
|
||||
- docs/models/components/clickscities.md
|
||||
- docs/models/components/clicksdevices.md
|
||||
- docs/models/components/clicksbrowsers.md
|
||||
- docs/models/components/clicksos.md
|
||||
- docs/models/components/clicksreferers.md
|
||||
- docs/models/components/clickstoplinks.md
|
||||
- docs/models/components/clickstopurls.md
|
||||
- docs/models/components/leadscount.md
|
||||
- docs/models/components/leadstimeseries.md
|
||||
- docs/models/components/leadscountriescountry.md
|
||||
- docs/models/components/leadscountries.md
|
||||
- docs/models/components/leadscitiescountry.md
|
||||
- docs/models/components/leadscities.md
|
||||
- docs/models/components/leadsdevices.md
|
||||
- docs/models/components/leadsbrowsers.md
|
||||
- docs/models/components/leadsos.md
|
||||
- docs/models/components/leadsreferers.md
|
||||
- docs/models/components/leadstoplinks.md
|
||||
- docs/models/components/leadstopurls.md
|
||||
- docs/models/components/salescount.md
|
||||
- docs/models/components/salestimeseries.md
|
||||
- docs/models/components/salescountriescountry.md
|
||||
- docs/models/components/salescountries.md
|
||||
- docs/models/components/salescitiescountry.md
|
||||
- docs/models/components/salescities.md
|
||||
- docs/models/components/salesdevices.md
|
||||
- docs/models/components/salesbrowsers.md
|
||||
- docs/models/components/salesos.md
|
||||
- docs/models/components/salesreferers.md
|
||||
- docs/models/components/salestoplinks.md
|
||||
- docs/models/components/salestopurls.md
|
||||
- docs/models/components/countrycode.md
|
||||
- docs/models/components/plan.md
|
||||
- docs/models/components/role.md
|
||||
- docs/models/components/users.md
|
||||
@@ -209,80 +249,12 @@ generatedFiles:
|
||||
- docs/models/operations/upsertlinkrequestbody.md
|
||||
- docs/models/operations/level.md
|
||||
- docs/models/operations/getqrcoderequest.md
|
||||
- docs/models/operations/gettimeseriesbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/gettimeseriesbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/gettimeseriesbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/gettimeseriesbyclicksdeprecatedresponsebody.md
|
||||
- docs/models/operations/getcountriesbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/getcountriesbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/getcountriesbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/getcitiesbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/getcitiesbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/getcitiesbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/getdevicesbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/getdevicesbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/getdevicesbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/getdevicesbyclicksdeprecatedresponsebody.md
|
||||
- docs/models/operations/getbrowsersbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/getbrowsersbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/getbrowsersbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/getbrowsersbyclicksdeprecatedresponsebody.md
|
||||
- docs/models/operations/getosbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/getosbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/getosbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/getosbyclicksdeprecatedresponsebody.md
|
||||
- docs/models/operations/getreferersbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/getreferersbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/getreferersbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/getreferersbyclicksdeprecatedresponsebody.md
|
||||
- docs/models/operations/gettoplinksbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/gettoplinksbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/gettoplinksbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/gettoplinksbyclicksdeprecatedresponsebody.md
|
||||
- docs/models/operations/gettopurlsbyclicksdeprecatedglobals.md
|
||||
- docs/models/operations/gettopurlsbyclicksdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/gettopurlsbyclicksdeprecatedrequest.md
|
||||
- docs/models/operations/gettopurlsbyclicksdeprecatedresponsebody.md
|
||||
- docs/models/operations/getclickscountglobals.md
|
||||
- docs/models/operations/retrieveanalyticsglobals.md
|
||||
- docs/models/operations/event.md
|
||||
- docs/models/operations/queryparamgroupby.md
|
||||
- docs/models/operations/interval.md
|
||||
- docs/models/operations/getclickscountrequest.md
|
||||
- docs/models/operations/gettimeseriesbyclicksglobals.md
|
||||
- docs/models/operations/queryparaminterval.md
|
||||
- docs/models/operations/gettimeseriesbyclicksrequest.md
|
||||
- docs/models/operations/responsebody.md
|
||||
- docs/models/operations/getcountriesbyclicksglobals.md
|
||||
- docs/models/operations/getcountriesbyclicksqueryparaminterval.md
|
||||
- docs/models/operations/getcountriesbyclicksrequest.md
|
||||
- docs/models/operations/getcitiesbyclicksglobals.md
|
||||
- docs/models/operations/getcitiesbyclicksqueryparaminterval.md
|
||||
- docs/models/operations/getcitiesbyclicksrequest.md
|
||||
- docs/models/operations/getdevicesbyclicksglobals.md
|
||||
- docs/models/operations/getdevicesbyclicksqueryparaminterval.md
|
||||
- docs/models/operations/getdevicesbyclicksrequest.md
|
||||
- docs/models/operations/getdevicesbyclicksresponsebody.md
|
||||
- docs/models/operations/getbrowsersbyclicksglobals.md
|
||||
- docs/models/operations/getbrowsersbyclicksqueryparaminterval.md
|
||||
- docs/models/operations/getbrowsersbyclicksrequest.md
|
||||
- docs/models/operations/getbrowsersbyclicksresponsebody.md
|
||||
- docs/models/operations/getosbyclicksglobals.md
|
||||
- docs/models/operations/getosbyclicksqueryparaminterval.md
|
||||
- docs/models/operations/getosbyclicksrequest.md
|
||||
- docs/models/operations/getosbyclicksresponsebody.md
|
||||
- docs/models/operations/getreferersbyclicksglobals.md
|
||||
- docs/models/operations/getreferersbyclicksqueryparaminterval.md
|
||||
- docs/models/operations/getreferersbyclicksrequest.md
|
||||
- docs/models/operations/getreferersbyclicksresponsebody.md
|
||||
- docs/models/operations/gettoplinksbyclicksglobals.md
|
||||
- docs/models/operations/gettoplinksbyclicksqueryparaminterval.md
|
||||
- docs/models/operations/gettoplinksbyclicksrequest.md
|
||||
- docs/models/operations/gettoplinksbyclicksresponsebody.md
|
||||
- docs/models/operations/gettopurlsbyclicksglobals.md
|
||||
- docs/models/operations/gettopurlsbyclicksqueryparaminterval.md
|
||||
- docs/models/operations/gettopurlsbyclicksrequest.md
|
||||
- docs/models/operations/gettopurlsbyclicksresponsebody.md
|
||||
- docs/models/operations/getclickscountdeprecatedglobals.md
|
||||
- docs/models/operations/getclickscountdeprecatedqueryparaminterval.md
|
||||
- docs/models/operations/getclickscountdeprecatedrequest.md
|
||||
- docs/models/operations/retrieveanalyticsrequest.md
|
||||
- docs/models/operations/retrieveanalyticsresponsebody.md
|
||||
- docs/models/operations/createworkspacerequestbody.md
|
||||
- docs/models/operations/getworkspacerequest.md
|
||||
- docs/models/operations/gettagsglobals.md
|
||||
@@ -320,7 +292,6 @@ generatedFiles:
|
||||
- docs/sdks/links/README.md
|
||||
- docs/sdks/qrcodes/README.md
|
||||
- docs/sdks/analytics/README.md
|
||||
- docs/sdks/clicks/README.md
|
||||
- docs/sdks/workspaces/README.md
|
||||
- docs/sdks/tags/README.md
|
||||
- docs/sdks/domains/README.md
|
||||
|
||||
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
typescript:
|
||||
version: 0.29.9
|
||||
version: 0.29.10
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies:
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
speakeasyVersion: 1.296.1
|
||||
speakeasyVersion: 1.297.0
|
||||
sources:
|
||||
my-first-source:
|
||||
sourceNamespace: my-first-source
|
||||
sourceRevisionDigest: sha256:0b285257c73443e338c219ce3a200d02ee30f8ac169aefeea1454a91ba338a43
|
||||
sourceBlobDigest: sha256:ac82ee79a3edd0ead797b2910ce6da07a17b216767cf70eb8db01d8936d545d3
|
||||
sourceRevisionDigest: sha256:6147693469ccc7ec8e6d64adeef85e435280d3c9dcff8e048755d979df72afca
|
||||
sourceBlobDigest: sha256:f7684488e2e9c9dfaa6b9844f66627f1ad6f42807cedbc35f51e63a917d7e20c
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -11,8 +11,8 @@ targets:
|
||||
my-first-target:
|
||||
source: my-first-source
|
||||
sourceNamespace: my-first-source
|
||||
sourceRevisionDigest: sha256:0b285257c73443e338c219ce3a200d02ee30f8ac169aefeea1454a91ba338a43
|
||||
sourceBlobDigest: sha256:ac82ee79a3edd0ead797b2910ce6da07a17b216767cf70eb8db01d8936d545d3
|
||||
sourceRevisionDigest: sha256:6147693469ccc7ec8e6d64adeef85e435280d3c9dcff8e048755d979df72afca
|
||||
sourceBlobDigest: sha256:f7684488e2e9c9dfaa6b9844f66627f1ad6f42807cedbc35f51e63a917d7e20c
|
||||
outLocation: /github/workspace/repo
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
|
||||
24
README.md
24
README.md
@@ -103,29 +103,7 @@ run();
|
||||
|
||||
### [analytics](docs/sdks/analytics/README.md)
|
||||
|
||||
* [~~timeseries~~](docs/sdks/analytics/README.md#timeseries) - Retrieve timeseries click analytics :warning: **Deprecated** Use `timeseries` instead.
|
||||
* [~~country~~](docs/sdks/analytics/README.md#country) - Retrieve top countries by clicks :warning: **Deprecated** Use `countries` instead.
|
||||
* [~~city~~](docs/sdks/analytics/README.md#city) - Retrieve top cities by clicks :warning: **Deprecated** Use `cities` instead.
|
||||
* [~~device~~](docs/sdks/analytics/README.md#device) - Retrieve top devices by clicks :warning: **Deprecated** Use `devices` instead.
|
||||
* [~~browser~~](docs/sdks/analytics/README.md#browser) - Retrieve top browsers by clicks :warning: **Deprecated** Use `browsers` instead.
|
||||
* [~~os~~](docs/sdks/analytics/README.md#os) - Retrieve top OS by clicks :warning: **Deprecated** Use `os` instead.
|
||||
* [~~referer~~](docs/sdks/analytics/README.md#referer) - Retrieve top referers by clicks :warning: **Deprecated** Use `referers` instead.
|
||||
* [~~topLinks~~](docs/sdks/analytics/README.md#toplinks) - Retrieve top links by clicks :warning: **Deprecated** Use `topLinks` instead.
|
||||
* [~~topUrls~~](docs/sdks/analytics/README.md#topurls) - Retrieve top URLs by clicks :warning: **Deprecated** Use `topUrls` instead.
|
||||
|
||||
### [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.
|
||||
* [retrieve](docs/sdks/analytics/README.md#retrieve) - Retrieve analytics for a link, a domain, or the authenticated workspace.
|
||||
|
||||
### [workspaces](docs/sdks/workspaces/README.md)
|
||||
|
||||
|
||||
10
RELEASES.md
10
RELEASES.md
@@ -357,3 +357,13 @@ Based on:
|
||||
- [typescript v0.29.9] .
|
||||
### Releases
|
||||
- [NPM v0.29.9] https://www.npmjs.com/package/dub/v/0.29.9 - .
|
||||
|
||||
## 2024-05-29 17:07:26
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.297.0 (2.338.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.29.10] .
|
||||
### Releases
|
||||
- [NPM v0.29.10] https://www.npmjs.com/package/dub/v/0.29.10 - .
|
||||
861
codeSamples.yaml
861
codeSamples.yaml
@@ -3,11 +3,11 @@ info:
|
||||
title: CodeSamples overlay for typescript target
|
||||
version: 0.0.0
|
||||
actions:
|
||||
- target: $["paths"]["/analytics/device"]["get"]
|
||||
- target: $["paths"]["/links/{linkId}"]["delete"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getDevicesByClicksDeprecated"
|
||||
"label": "deleteLink"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
@@ -17,96 +17,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.device({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/clicks/count"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getClicksCount"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/analytics/clicks/countries"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getCountriesByClicks"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/workspaces"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "createWorkspace"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.workspaces.create({
|
||||
name: "<value>",
|
||||
slug: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/track/customer"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "trackCustomer"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.track.customer({
|
||||
customerId: "<value>",
|
||||
});
|
||||
const result = await dub.links.delete("<value>");
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -136,11 +47,11 @@ actions:
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/country"]["get"]
|
||||
- target: $["paths"]["/analytics"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getCountriesByClicksDeprecated"
|
||||
"label": "retrieveAnalytics"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
@@ -150,28 +61,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.country({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/clicks/devices"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getDevicesByClicks"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.clicks.devices({});
|
||||
const result = await dub.analytics.retrieve({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -199,11 +89,11 @@ actions:
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/tags"]["post"]
|
||||
- target: $["paths"]["/domains/{slug}"]["patch"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "createTag"
|
||||
"label": "updateDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
@@ -213,35 +103,7 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.tags.create({
|
||||
tag: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/track/sale"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "trackSale"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
import { PaymentProcessor } from "dub/models/operations";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.track.sale({
|
||||
customerId: "<value>",
|
||||
amount: 996500,
|
||||
paymentProcessor: PaymentProcessor.Shopify,
|
||||
});
|
||||
const result = await dub.domains.update("acme.com", {});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
@@ -270,111 +132,6 @@ actions:
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/links"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getLinks"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.links.list({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/clicks/timeseries"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getTimeseriesByClicks"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/analytics/top_urls"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getTopURLsByClicksDeprecated"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.topUrls({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/city"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getCitiesByClicksDeprecated"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.city({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/clicks/os"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getOSByClicks"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/workspaces"]["get"]
|
||||
update:
|
||||
@@ -396,6 +153,53 @@ actions:
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains/{slug}"]["delete"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "deleteDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.delete("acme.com");
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/track/sale"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "trackSale"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
import { PaymentProcessor } from "dub/models/operations";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.track.sale({
|
||||
customerId: "<value>",
|
||||
amount: 996500,
|
||||
paymentProcessor: PaymentProcessor.Shopify,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/links"]["post"]
|
||||
update:
|
||||
@@ -441,11 +245,11 @@ actions:
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/browser"]["get"]
|
||||
- target: $["paths"]["/workspaces"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getBrowsersByClicksDeprecated"
|
||||
"label": "createWorkspace"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
@@ -455,18 +259,21 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.browser({});
|
||||
const result = await dub.workspaces.create({
|
||||
name: "<value>",
|
||||
slug: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/referer"]["get"]
|
||||
- target: $["paths"]["/workspaces/{idOrSlug}"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getReferersByClicksDeprecated"
|
||||
"label": "getWorkspace"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
@@ -476,18 +283,20 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.referer({});
|
||||
const result = await dub.workspaces.get({
|
||||
idOrSlug: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/clicks/browsers"]["get"]
|
||||
- target: $["paths"]["/tags"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getBrowsersByClicks"
|
||||
"label": "createTag"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
@@ -497,18 +306,20 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.clicks.browsers({});
|
||||
const result = await dub.tags.create({
|
||||
tag: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains"]["post"]
|
||||
- target: $["paths"]["/domains/{slug}/primary"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "addDomain"
|
||||
"label": "setPrimaryDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
@@ -518,8 +329,52 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.add({
|
||||
slug: "acme.com",
|
||||
const result = await dub.domains.setPrimary("acme.com");
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/track/customer"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "trackCustomer"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.track.customer({
|
||||
customerId: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains/{slug}/transfer"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "transferDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.transfer("acme.com", {
|
||||
newWorkspaceId: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
@@ -549,6 +404,48 @@ actions:
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/links"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getLinks"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.links.list({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/links/info"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getLinkInfo"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.links.get({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/links/{linkId}"]["patch"]
|
||||
update:
|
||||
@@ -572,6 +469,75 @@ actions:
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/links/bulk"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "bulkCreateLinks"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.links.createMany([
|
||||
{
|
||||
url: "https://google/com",
|
||||
},
|
||||
]);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "listDomains"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.list({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "addDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.add({
|
||||
slug: "acme.com",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/track/lead"]["post"]
|
||||
update:
|
||||
@@ -597,369 +563,4 @@ actions:
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/timeseries"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getTimeseriesByClicksDeprecated"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.timeseries({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/top_links"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getTopLinksByClicksDeprecated"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.topLinks({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/clicks/referers"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getReferersByClicks"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/workspaces/{idOrSlug}"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getWorkspace"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.workspaces.get({
|
||||
idOrSlug: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains/{slug}"]["delete"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "deleteDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.delete("acme.com");
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains/{slug}"]["patch"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "updateDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.update("acme.com", {});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/os"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getOSByClicksDeprecated"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.analytics.os({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/clicks/cities"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getCitiesByClicks"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/links/bulk"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "bulkCreateLinks"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.links.createMany([
|
||||
{
|
||||
url: "https://google/com",
|
||||
},
|
||||
]);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/analytics/clicks/top_links"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getTopLinksByClicks"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/analytics/clicks/top_urls"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getTopURLsByClicks"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/analytics/clicks"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getClicksCountDeprecated"
|
||||
"source": |-
|
||||
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();
|
||||
- target: $["paths"]["/domains"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "listDomains"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.list({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains/{slug}/primary"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "setPrimaryDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.setPrimary("acme.com");
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/links/info"]["get"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "getLinkInfo"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.links.get({});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/links/{linkId}"]["delete"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "deleteLink"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.links.delete("<value>");
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/domains/{slug}/transfer"]["post"]
|
||||
update:
|
||||
"x-codeSamples":
|
||||
- "lang": "typescript"
|
||||
"label": "transferDomain"
|
||||
"source": |-
|
||||
import { Dub } from "dub";
|
||||
|
||||
const dub = new Dub({
|
||||
token: "DUB_API_KEY",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await dub.domains.transfer("acme.com", {
|
||||
newWorkspaceId: "<value>",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetBrowsersByClicksResponseBody
|
||||
# ClicksBrowsers
|
||||
|
||||
|
||||
## Fields
|
||||
10
docs/models/components/clickscities.md
Normal file
10
docs/models/components/clickscities.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ClicksCities
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `city` | *string* | :heavy_check_mark: | The name of the city |
|
||||
| `country` | [components.ClicksCitiesCountry](../../models/components/clickscitiescountry.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 |
|
||||
@@ -1,4 +1,4 @@
|
||||
# ClicksByCitiesCountry
|
||||
# ClicksCitiesCountry
|
||||
|
||||
The 2-letter country code of the city: https://d.to/geo
|
||||
|
||||
8
docs/models/components/clickscount.md
Normal file
8
docs/models/components/clickscount.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ClicksCount
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
|
||||
| `clicks` | *number* | :heavy_check_mark: | The total number of clicks |
|
||||
@@ -1,4 +1,4 @@
|
||||
# ClicksByCountry
|
||||
# ClicksCountries
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetDevicesByClicksResponseBody
|
||||
# ClicksDevices
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetOSByClicksResponseBody
|
||||
# ClicksOS
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetReferersByClicksResponseBody
|
||||
# ClicksReferers
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,4 +1,4 @@
|
||||
# ResponseBody
|
||||
# ClicksTimeseries
|
||||
|
||||
|
||||
## Fields
|
||||
15
docs/models/components/clickstoplinks.md
Normal file
15
docs/models/components/clickstoplinks.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# ClicksTopLinks
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ~~`link`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the short link |
|
||||
| `id` | *string* | :heavy_check_mark: | The unique ID of the short link |
|
||||
| `domain` | *string* | :heavy_check_mark: | The domain of the short link |
|
||||
| `key` | *string* | :heavy_check_mark: | The key of the short link |
|
||||
| `shortLink` | *string* | :heavy_check_mark: | The short link URL |
|
||||
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link |
|
||||
| `createdAt` | *string* | :heavy_check_mark: | The creation timestamp of the short link |
|
||||
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this link |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetTopURLsByClicksResponseBody
|
||||
# ClicksTopUrls
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -1,9 +1,9 @@
|
||||
# GetDevicesByClicksDeprecatedResponseBody
|
||||
# LeadsBrowsers
|
||||
|
||||
|
||||
## 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 |
|
||||
| `browser` | *string* | :heavy_check_mark: | The name of the browser |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads from this browser |
|
||||
10
docs/models/components/leadscities.md
Normal file
10
docs/models/components/leadscities.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# LeadsCities
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `city` | *string* | :heavy_check_mark: | The name of the city |
|
||||
| `country` | [components.LeadsCitiesCountry](../../models/components/leadscitiescountry.md) | :heavy_check_mark: | The 2-letter country code of the city: https://d.to/geo |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads from this city |
|
||||
259
docs/models/components/leadscitiescountry.md
Normal file
259
docs/models/components/leadscitiescountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# LeadsCitiesCountry
|
||||
|
||||
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 |
|
||||
8
docs/models/components/leadscount.md
Normal file
8
docs/models/components/leadscount.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# LeadsCount
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `leads` | *number* | :heavy_check_mark: | The total number of leads |
|
||||
9
docs/models/components/leadscountries.md
Normal file
9
docs/models/components/leadscountries.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# LeadsCountries
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `country` | [components.LeadsCountriesCountry](../../models/components/leadscountriescountry.md) | :heavy_check_mark: | The 2-letter country code: https://d.to/geo |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads from this country |
|
||||
259
docs/models/components/leadscountriescountry.md
Normal file
259
docs/models/components/leadscountriescountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# LeadsCountriesCountry
|
||||
|
||||
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 |
|
||||
9
docs/models/components/leadsdevices.md
Normal file
9
docs/models/components/leadsdevices.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# LeadsDevices
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `device` | *string* | :heavy_check_mark: | The name of the device |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads from this device |
|
||||
9
docs/models/components/leadsos.md
Normal file
9
docs/models/components/leadsos.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# LeadsOS
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `os` | *string* | :heavy_check_mark: | The name of the OS |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads from this OS |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetReferersByClicksDeprecatedResponseBody
|
||||
# LeadsReferers
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -6,4 +6,4 @@
|
||||
| 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 |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads from this referer |
|
||||
@@ -1,4 +1,4 @@
|
||||
# GetTimeseriesByClicksDeprecatedResponseBody
|
||||
# LeadsTimeseries
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -6,4 +6,4 @@
|
||||
| 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 |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads in the interval |
|
||||
15
docs/models/components/leadstoplinks.md
Normal file
15
docs/models/components/leadstoplinks.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# LeadsTopLinks
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ~~`link`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the short link |
|
||||
| `id` | *string* | :heavy_check_mark: | The unique ID of the short link |
|
||||
| `domain` | *string* | :heavy_check_mark: | The domain of the short link |
|
||||
| `key` | *string* | :heavy_check_mark: | The key of the short link |
|
||||
| `shortLink` | *string* | :heavy_check_mark: | The short link URL |
|
||||
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link |
|
||||
| `createdAt` | *string* | :heavy_check_mark: | The creation timestamp of the short link |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads from this link |
|
||||
9
docs/models/components/leadstopurls.md
Normal file
9
docs/models/components/leadstopurls.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# LeadsTopUrls
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||
| `url` | *string* | :heavy_check_mark: | The destination URL |
|
||||
| `leads` | *number* | :heavy_check_mark: | The number of leads from this URL |
|
||||
10
docs/models/components/salesbrowsers.md
Normal file
10
docs/models/components/salesbrowsers.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# SalesBrowsers
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| `browser` | *string* | :heavy_check_mark: | The name of the browser |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales from this browser |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales from this browser |
|
||||
11
docs/models/components/salescities.md
Normal file
11
docs/models/components/salescities.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# SalesCities
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `city` | *string* | :heavy_check_mark: | The name of the city |
|
||||
| `country` | [components.SalesCitiesCountry](../../models/components/salescitiescountry.md) | :heavy_check_mark: | The 2-letter country code of the city: https://d.to/geo |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales from this city |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales from this city |
|
||||
259
docs/models/components/salescitiescountry.md
Normal file
259
docs/models/components/salescitiescountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# SalesCitiesCountry
|
||||
|
||||
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 |
|
||||
9
docs/models/components/salescount.md
Normal file
9
docs/models/components/salescount.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# SalesCount
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `sales` | *number* | :heavy_check_mark: | The total number of sales |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales |
|
||||
@@ -1,10 +1,10 @@
|
||||
# ClicksByCities
|
||||
# SalesCountries
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `city` | *string* | :heavy_check_mark: | The name of the city |
|
||||
| `country` | [components.ClicksByCitiesCountry](../../models/components/clicksbycitiescountry.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 |
|
||||
| `country` | [components.SalesCountriesCountry](../../models/components/salescountriescountry.md) | :heavy_check_mark: | The 2-letter country code: https://d.to/geo |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales from this country |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales from this country |
|
||||
259
docs/models/components/salescountriescountry.md
Normal file
259
docs/models/components/salescountriescountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# SalesCountriesCountry
|
||||
|
||||
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 |
|
||||
10
docs/models/components/salesdevices.md
Normal file
10
docs/models/components/salesdevices.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# SalesDevices
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||
| `device` | *string* | :heavy_check_mark: | The name of the device |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales from this device |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales from this device |
|
||||
@@ -1,9 +1,10 @@
|
||||
# GetBrowsersByClicksDeprecatedResponseBody
|
||||
# SalesOS
|
||||
|
||||
|
||||
## 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 |
|
||||
| `os` | *string* | :heavy_check_mark: | The name of the OS |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales from this OS |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales from this OS |
|
||||
10
docs/models/components/salesreferers.md
Normal file
10
docs/models/components/salesreferers.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# SalesReferers
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `referer` | *string* | :heavy_check_mark: | The name of the referer. If unknown, this will be `(direct)` |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales from this referer |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales from this referer |
|
||||
10
docs/models/components/salestimeseries.md
Normal file
10
docs/models/components/salestimeseries.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# SalesTimeseries
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| `start` | *string* | :heavy_check_mark: | The starting timestamp of the interval |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales in the interval |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales in the interval |
|
||||
16
docs/models/components/salestoplinks.md
Normal file
16
docs/models/components/salestoplinks.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# SalesTopLinks
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ~~`link`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the short link |
|
||||
| `id` | *string* | :heavy_check_mark: | The unique ID of the short link |
|
||||
| `domain` | *string* | :heavy_check_mark: | The domain of the short link |
|
||||
| `key` | *string* | :heavy_check_mark: | The key of the short link |
|
||||
| `shortLink` | *string* | :heavy_check_mark: | The short link URL |
|
||||
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link |
|
||||
| `createdAt` | *string* | :heavy_check_mark: | The creation timestamp of the short link |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales from this link |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales from this link |
|
||||
10
docs/models/components/salestopurls.md
Normal file
10
docs/models/components/salestopurls.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# SalesTopUrls
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| `url` | *string* | :heavy_check_mark: | The destination URL |
|
||||
| `sales` | *number* | :heavy_check_mark: | The number of sales from this URL |
|
||||
| `amount` | *number* | :heavy_check_mark: | The total amount of sales from this URL |
|
||||
13
docs/models/operations/event.md
Normal file
13
docs/models/operations/event.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Event
|
||||
|
||||
The type of event to retrieve analytics for. Defaults to 'clicks'.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `Clicks` | clicks |
|
||||
| `Leads` | leads |
|
||||
| `Sales` | sales |
|
||||
| `Composite` | composite |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetBrowsersByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetBrowsersByClicksGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetBrowsersByClicksRequest
|
||||
|
||||
|
||||
## 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.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. |
|
||||
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
|
||||
| `country` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetCitiesByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# GetCitiesByClicksQueryParamInterval
|
||||
|
||||
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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetCitiesByClicksRequest
|
||||
|
||||
|
||||
## 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.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. |
|
||||
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
|
||||
| `country` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetClicksCountDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetClicksCountGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetCountriesByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetCountriesByClicksGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetDevicesByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetDevicesByClicksGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# GetDevicesByClicksQueryParamInterval
|
||||
|
||||
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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetDevicesByClicksRequest
|
||||
|
||||
|
||||
## 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.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. |
|
||||
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
|
||||
| `country` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetOSByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetOSByClicksGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# GetOSByClicksQueryParamInterval
|
||||
|
||||
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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetOSByClicksRequest
|
||||
|
||||
|
||||
## 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.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. |
|
||||
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
|
||||
| `country` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetReferersByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetReferersByClicksGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetReferersByClicksRequest
|
||||
|
||||
|
||||
## 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.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. |
|
||||
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
|
||||
| `country` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetTimeseriesByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetTimeseriesByClicksGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,24 +0,0 @@
|
||||
# GetTimeseriesByClicksRequest
|
||||
|
||||
|
||||
## 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.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. |
|
||||
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. |
|
||||
| `country` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetTopLinksByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetTopLinksByClicksGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetTopLinksByClicksResponseBody
|
||||
|
||||
|
||||
## 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 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetTopURLsByClicksDeprecatedGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
@@ -1,17 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,24 +0,0 @@
|
||||
# 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` | [components.CountryCode](../../models/components/countrycode.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. |
|
||||
@@ -1,9 +0,0 @@
|
||||
# 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 |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetTopURLsByClicksGlobals
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | N/A |
|
||||
| ~~`projectSlug`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user