GET
/
v1
/
analytics
/
{workspace_id}
curl --request GET \
  --url https://api.ziplink.click/v1/analytics/{workspace_id} \
  --header 'Authorization: Bearer <token>'
{
  "browser_families": [
    {
      "count": 123,
      "name": "Firefox"
    },
    {
      "count": 123,
      "name": "Chrome"
    },
    {
      "count": 123,
      "name": "Mobile Chrome"
    }
  ],
  "cities": [
    {
      "count": 123,
      "name": "Dubai"
    }
  ],
  "continents": [
    {
      "count": 123,
      "name": "AS"
    }
  ],
  "countries": [
    {
      "count": 123,
      "name": "AE"
    }
  ],
  "device_types": [
    {
      "count": 123,
      "name": "desktop"
    },
    {
      "count": 123,
      "name": "mobile"
    },
    {
      "count": 123,
      "name": "tablet"
    }
  ],
  "os_names": [
    {
      "count": 123,
      "name": "Linux"
    },
    {
      "count": 123,
      "name": "macOS"
    },
    {
      "count": 123,
      "name": "Windows"
    }
  ],
  "records": [
    {
      "clicks": 123,
      "date": "2024-01-31T01:30:00",
      "scans": 123
    }
  ],
  "referrers": [
    {
      "count": 123,
      "name": "https://example.com"
    },
    {
      "count": 123,
      "name": "https://opcotech.com"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string
required

ID of the workspace.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

Query Parameters

​
link-id
string

ID of the link.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
continent
string

The name of the continent from which the request originated.

Example:

"AS"

​
country
string

The code of the country from which the request originated.

Example:

"AE"

​
city
string

The name of the city from which the request originated.

Example:

"Dubai"

​
browser-family
string

The browser family of the client which sent the request.

Example:

"Firefox"

​
device-type
string

The type of the device which sent the request.

Example:

"Android 10"

​
os-name
string

The operating system name of the device.

Example:

"Android"

​
referrer
string

Domain name of the web page that made the request.

Example:

"example.com"

​
source
enum<string>

The action that triggered saving the record.

Available options:
click,
scan
Example:

"click"

​
start-date
string

The date that will be used to query results from.

​
end-date
string

The date that will be used to query results until.

Response

200
application/json
OK
​
browser_families
object[]
required

Browser families used to visit the destination URL.

Example:
[
  { "count": 123, "name": "Firefox" },
  { "count": 123, "name": "Chrome" },
  { "count": 123, "name": "Mobile Chrome" }
]
​
cities
object[]
required

Cities from where the link was clicked or scanned.

Example:
[{ "count": 123, "name": "Dubai" }]
​
continents
object[]
required

Continents from where the link was clicked or scanned.

Example:
[{ "count": 123, "name": "AS" }]
​
countries
object[]
required

Countries from where the link was clicked or scanned.

Example:
[{ "count": 123, "name": "AE" }]
​
device_types
object[]
required

Device types used to visit the destination URL.

Example:
[
  { "count": 123, "name": "desktop" },
  { "count": 123, "name": "mobile" },
  { "count": 123, "name": "tablet" }
]
​
os_names
object[]
required

Operating systems used to visit the destination URL.

Example:
[
  { "count": 123, "name": "Linux" },
  { "count": 123, "name": "macOS" },
  { "count": 123, "name": "Windows" }
]
​
records
object[]
required

Daily summary of clicks and scans.

Example:
[
  {
    "clicks": 123,
    "date": "2024-01-31T01:30:00",
    "scans": 123
  }
]
​
referrers
object[]
required

Referrers from where the user navigated to the URL.

Example:
[
  {
    "count": 123,
    "name": "https://example.com"
  },
  {
    "count": 123,
    "name": "https://opcotech.com"
  }
]