Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement APIUsers APIOperations APIMessaging APIReporting API
ML APIData API
ExplorePublic APIManagement APIUsers APIOperations APIMessaging APIReporting API
ML APIData API
  1. Links
  • Introduction
  • Filter parameter specification
  • Data formats
    • Records
    • Timeseries
  • Reports
    • Members
      • members (records)
      • members_count (records)
      • members_grouped_count (records)
      • member_balance (timeseries)
      • members_count_snapshot (timeseries)
      • members_count_history (timeseries)
    • Sendings
      • sendings (records)
      • sendings_events_history (timeseries)
      • sendings_recipients_statistics (timeseries)
      • sendings_links (records)
      • sendings_links_stats (records)
      • Examples
        • sendings - find sending by reporting_id
        • sendings_events_history - show sending events
        • sendings_recipients_statistics - show recipients by age groups
    • Links
      • links_visits_history (timeseries)
  • Geo API
    • Find Locations Coordinates
      POST
    • List places
      POST
    • Show place
      GET
  • Metadata
    POST
  • Field metadata
    POST
  • Query (records)
    POST
  • Query (timeseries)
    POST
  • Query (records) export
    POST
  • Query (timeseries) export
    POST
  • Tenants query (records) export
    POST
  • Tenants query (timeseries) export
    POST
  1. Links

links_visits_history (timeseries)

Required permitRate limit tokens costAvailable intervals
Reporting:Api:Report:LinksVisitsHistory35m, 1h, 1d, 1w, 1mo
This report allows you to get information about resolved links.

Fields#

loyalty_club_id#

TypeFilterable
Integer (via X-Customer header)
ID of loyalty club.

source_type#

TypeFilterable
Enum
Type of system component from which link visit was generated.
This field is an enum, possible values are:
landing_page
website
tracker_sending
tracker_api

source_id#

TypeFilterable
String
Identifier set by component from which link was generated.

host#

TypeFilterable
String
Host of tracked URL.

path#

TypeFilterable
String
Path of tracked URL.

device_type#

TypeFilterable
Enum
Device used to visit the link.
This field is an enum, possible values are:
mobile
desktop
tablet
bot

ip_country#

TypeFilterable
String(ISO 3166-1 alpha-2)
Country of IP address.

ip_subdivision#

TypeFilterable
String
Subdivision of IP address.
Examples:
USA states codes: CA, MI, DC, etc.

user_agent_name#

TypeFilterable
String
Short identifier of user agent.
Examples:
Safari
Chrome
iPhone
Googlebot

Query without aggregations#

Query returns series with numbers of links visits.
{
    "interval": "1d",
    "range_timezone": "Europe/Oslo",
    "time_buckets": [
        "2025-08-29T00:00:00.000+02:00"
    ],
    "series": [
        {
            "label": {},
            "values": [
                1148
            ]
        }
    ],
    "data_points": 1,
    "result_type": "timeseries"
}

Aggregations#

device_type#

Fetch visits data aggregated by device_type.

Labels#

KeyTypeDescription
device_typeEnumSee in Fields

Example query response#

{
    "interval": "1d",
    "range_timezone": "Europe/Oslo",
    "time_buckets": [
        "2025-08-29T00:00:00.000+02:00"
    ],
    "series": [
        {
            "label": {
                "device_type": "mobile"
            },
            "values": [
                885
            ]
        },
        {
            "label": {
                "device_type": "tablet"
            },
            "values": [
                2
            ]
        },
        {
            "label": {
                "device_type": "desktop"
            },
            "values": [
                3
            ]
        },
        {
            "label": {
                "device_type": "bot"
            },
            "values": [
                16
            ]
        },
        {
            "label": {
                "device_type": null
            },
            "values": [
                240
            ]
        }
    ],
    "data_points": 5,
    "result_type": "timeseries"
}
Previous
sendings_recipients_statistics - show recipients by age groups
Next
Find Locations Coordinates
Built with