Retrieve analytics

GET

documents

{id}

stats

curl --request GET \
  --url https://api.reqlick.com/documents/{id}/stats \
  --header 'Authorization: Bearer <token>'

{
  "views": [
    {
      "id": "1110580a82031111aaa03333",
      "linkId": "1110580a82031111aaa03333",
      "documentId": "1110580a82031111aaa03333",
      "projectId": "6660580a43f1a356b97f64b9",
      "viewedAt": "2024-07-17T07:17:04.264Z",
      "isBot": false,
      "qrcodeId": null,
      "viewData": {
        "id": "1110580a82031111aaa03333",
        "viewId": "1110580a82031111aaa03333",
        "h_userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
        "h_referer": "https://www.linkedin.com/",
        "h_acceptLanguage": "fr-FR,fr;q=0.9,en-US;q=0.8,en;q=0.7",
        "h_sec_ch_ua_platform": "Windows",
        "sessionId": "688d2118-acaf-5d2f-854b-5baf4eb5093b",
        "b_screen_width": 1366,
        "b_screen_height": 768,
        "b_hostname": "rqk.sh",
        "b_pathname": "/try-reqlick",
        "b_language": "fr-FR",
        "b_search": "",
        "b_geo": {
          "b_isLocated": false,
          "b_error": {}
        },
        "newProjectVisitor": false,
        "newLinkVisitor": false,
        "v_start_time": "2024-07-17T07:17:04.264Z",
        "v_end_time": "2024-07-23T12:51:17.457Z",
        "updatedAt": "2024-07-23T12:51:17.458Z",
        "recordingEventsId": "<string>",
        "device": "Desktop",
        "screenResolution": "1366x768",
        "deviceVendor": "<string>",
        "browser": "Chrome",
        "browserEngine": "Blink",
        "os": "Windows",
        "source": "www.linkedin.com",
        "country": "France",
        "countryCode": "FR",
        "region": "Île-de-France",
        "regionCode": "<string>",
        "city": "Paris",
        "lat": 48.8323,
        "long": 2.4075
      }
    }
  ],
  "uniqueVisitorCount": 4,
  "averageVisitTime": "79375.20",
  "chartdata": [
    {
      "date": "Jul 16",
      "UniqueVisitors": 4,
      "PageViews": 5,
      "newVisitors": 4,
      "returnVisitors": 1
    }
  ],
  "links": [
    {
      "name": "<string>",
      "value": 7
    }
  ],
  "linksMax": 7,
  "all": [
    {
      "name": "www.linkedin.com",
      "value": 2
    }
  ],
  "allMax": 7,
  "browsersMax": 7,
  "osMax": 7,
  "devicesMax": 7,
  "deviceTypeMax": 7,
  "browsers": [
    {
      "name": "Chrome",
      "value": 7
    }
  ],
  "engines": [
    {
      "name": "Blink",
      "value": 7
    }
  ],
  "os": [
    {
      "name": "Windows",
      "value": 5
    }
  ],
  "devices": [
    {
      "name": "<string>",
      "value": 5
    }
  ],
  "deviceType": [
    {
      "name": "Desktop",
      "value": 7
    }
  ],
  "languages": [
    {
      "name": "French",
      "value": 2
    }
  ],
  "languagesMax": 7,
  "countries": [
    {
      "name": "France",
      "shortCode": "FR",
      "value": 6
    }
  ],
  "regions": [
    {
      "country": "France",
      "name": "Occitanie",
      "value": 3
    }
  ],
  "cities": [
    {
      "country": "France",
      "name": "Toulouse",
      "value": 3
    }
  ],
  "internetProviders": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Document ID

Query Parameters

workspace

string

required

Workspace URL

startDate

string | null

endDate

string | null

Response

200

application/json

Get detailed analytics data

views

object[]

views.id

string

View ID

Example:

"1110580a82031111aaa03333"

views.linkId

string

Link ID

Example:

"1110580a82031111aaa03333"

views.documentId

string

Document ID

Example:

"1110580a82031111aaa03333"

views.projectId

string

Workspace ID

Example:

"6660580a43f1a356b97f64b9"

views.viewedAt

string

Time when the document was viewed

Example:

"2024-07-17T07:17:04.264Z"

views.isBot

boolean

Indicates if the viewer is a bot

Example:

false

views.qrcodeId

string

QR code ID associated with the view

Example:

null

views.viewData

object

views.viewData.id

string

View data ID

Example:

"1110580a82031111aaa03333"

views.viewData.viewId

string

View ID

Example:

"1110580a82031111aaa03333"

views.viewData.h_userAgent

string

User agent string

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36"

views.viewData.h_referer

string

Referrer URL

Example:

"https://www.linkedin.com/"

views.viewData.h_acceptLanguage

string

Accepted languages

Example:

"fr-FR,fr;q=0.9,en-US;q=0.8,en;q=0.7"

views.viewData.h_sec_ch_ua_platform

string

User agent platform

Example:

"Windows"

views.viewData.sessionId

string

Session ID

Example:

"688d2118-acaf-5d2f-854b-5baf4eb5093b"

views.viewData.b_screen_width

integer

Screen width

Example:

1366

views.viewData.b_screen_height

integer

Screen height

Example:

768

views.viewData.b_hostname

string

Hostname

Example:

"rqk.sh"

views.viewData.b_pathname

string

Pathname

Example:

"/try-reqlick"

views.viewData.b_language

string

Browser language

Example:

"fr-FR"

views.viewData.b_search

string

Search query

Example:

""

views.viewData.b_geo

object

views.viewData.newProjectVisitor

boolean

Indicates if this is a new project visitor

Example:

false

views.viewData.newLinkVisitor

boolean

Indicates if this is a new link visitor

Example:

false

views.viewData.v_start_time

string

View start time

Example:

"2024-07-17T07:17:04.264Z"

views.viewData.v_end_time

string

View end time

Example:

"2024-07-23T12:51:17.457Z"

views.viewData.updatedAt

string

Last update time

Example:

"2024-07-23T12:51:17.458Z"

views.viewData.recordingEventsId

string

Recording events ID

views.viewData.device

string

Device type

Example:

"Desktop"

views.viewData.screenResolution

string

Screen resolution

Example:

"1366x768"

views.viewData.deviceVendor

string

Device vendor

views.viewData.browser

string

Browser name

Example:

"Chrome"

views.viewData.browserEngine

string

Browser engine

Example:

"Blink"

views.viewData.os

string

Operating system

Example:

"Windows"

views.viewData.source

string

Traffic source

Example:

"www.linkedin.com"

views.viewData.country

string

Country name

Example:

"France"

views.viewData.countryCode

string

Country code

Example:

"FR"

views.viewData.region

string

Region name

Example:

"Île-de-France"

views.viewData.regionCode

string

Region code

views.viewData.city

string

City name

Example:

"Paris"

views.viewData.lat

number

Latitude

Example:

48.8323

views.viewData.long

number

Longitude

Example:

2.4075

uniqueVisitorCount

integer

Number of unique visitors

Example:

4

averageVisitTime

string

Average visit time in ms

Example:

"79375.20"

chartdata

object[]

links

object[]

linksMax

integer

Maximum value for links

Example:

7

all

object[]

allMax

integer

Maximum value for all sources

Example:

7

browsersMax

integer

Maximum value for browsers

Example:

7

osMax

integer

Maximum value for operating systems

Example:

7

devicesMax

integer

Maximum value for devices

Example:

7

deviceTypeMax

integer

Maximum value for device types

Example:

7

browsers

object[]

engines

object[]

devices

object[]

deviceType

object[]

languages

object[]

languagesMax

integer

Maximum value for languages

Example:

7

countries

object[]

regions

object[]

cities

object[]

internetProviders

object[]

List of internet providers

Retrieve a list of links Create a new document

curl --request GET \
  --url https://api.reqlick.com/documents/{id}/stats \
  --header 'Authorization: Bearer <token>'

{
  "views": [
    {
      "id": "1110580a82031111aaa03333",
      "linkId": "1110580a82031111aaa03333",
      "documentId": "1110580a82031111aaa03333",
      "projectId": "6660580a43f1a356b97f64b9",
      "viewedAt": "2024-07-17T07:17:04.264Z",
      "isBot": false,
      "qrcodeId": null,
      "viewData": {
        "id": "1110580a82031111aaa03333",
        "viewId": "1110580a82031111aaa03333",
        "h_userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
        "h_referer": "https://www.linkedin.com/",
        "h_acceptLanguage": "fr-FR,fr;q=0.9,en-US;q=0.8,en;q=0.7",
        "h_sec_ch_ua_platform": "Windows",
        "sessionId": "688d2118-acaf-5d2f-854b-5baf4eb5093b",
        "b_screen_width": 1366,
        "b_screen_height": 768,
        "b_hostname": "rqk.sh",
        "b_pathname": "/try-reqlick",
        "b_language": "fr-FR",
        "b_search": "",
        "b_geo": {
          "b_isLocated": false,
          "b_error": {}
        },
        "newProjectVisitor": false,
        "newLinkVisitor": false,
        "v_start_time": "2024-07-17T07:17:04.264Z",
        "v_end_time": "2024-07-23T12:51:17.457Z",
        "updatedAt": "2024-07-23T12:51:17.458Z",
        "recordingEventsId": "<string>",
        "device": "Desktop",
        "screenResolution": "1366x768",
        "deviceVendor": "<string>",
        "browser": "Chrome",
        "browserEngine": "Blink",
        "os": "Windows",
        "source": "www.linkedin.com",
        "country": "France",
        "countryCode": "FR",
        "region": "Île-de-France",
        "regionCode": "<string>",
        "city": "Paris",
        "lat": 48.8323,
        "long": 2.4075
      }
    }
  ],
  "uniqueVisitorCount": 4,
  "averageVisitTime": "79375.20",
  "chartdata": [
    {
      "date": "Jul 16",
      "UniqueVisitors": 4,
      "PageViews": 5,
      "newVisitors": 4,
      "returnVisitors": 1
    }
  ],
  "links": [
    {
      "name": "<string>",
      "value": 7
    }
  ],
  "linksMax": 7,
  "all": [
    {
      "name": "www.linkedin.com",
      "value": 2
    }
  ],
  "allMax": 7,
  "browsersMax": 7,
  "osMax": 7,
  "devicesMax": 7,
  "deviceTypeMax": 7,
  "browsers": [
    {
      "name": "Chrome",
      "value": 7
    }
  ],
  "engines": [
    {
      "name": "Blink",
      "value": 7
    }
  ],
  "os": [
    {
      "name": "Windows",
      "value": 5
    }
  ],
  "devices": [
    {
      "name": "<string>",
      "value": 5
    }
  ],
  "deviceType": [
    {
      "name": "Desktop",
      "value": 7
    }
  ],
  "languages": [
    {
      "name": "French",
      "value": 2
    }
  ],
  "languagesMax": 7,
  "countries": [
    {
      "name": "France",
      "shortCode": "FR",
      "value": 6
    }
  ],
  "regions": [
    {
      "country": "France",
      "name": "Occitanie",
      "value": 3
    }
  ],
  "cities": [
    {
      "country": "France",
      "name": "Toulouse",
      "value": 3
    }
  ],
  "internetProviders": [
    {}
  ]
}

API Documentation

Links

QR Codes

Documents

Workspaces

Domains

Subscriptions

Users

Authorizations

Path Parameters

Query Parameters

Response