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. Sendings
  • 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. Sendings

sendings_links (records)

Required permitRate limit tokens cost
Reporting:Api:Report:SendingsLinks3
This report allows you to get information about performance of links which were sent within sendings in your loyalty club.

Fields#

loyalty_club_id#

TypeFilterableCan change?
Integer (via X-Customer header)
ID of loyalty club.

source_id#

TypeFilterableCan change?
String
Source_id defines from which place the sending was sent.
It can take two forms:
FormWhat is it?When?
stringified numberreporting_id of sendingAlways when reporting_id is present on sending. It's always set e.g. in campaign or triggered sendings.
text valueservice_type of sendingWhen reporting_id is empty

host#

TypeFilterableCan change?
String
Host of tracked URL.

path#

TypeFilterableCan change?
Enum
Path of tracked URL.

utm_campaign#

TypeFilterableCan change?
String
Value of utm_campaign query param.

utm_content#

TypeFilterableCan change?
String
Value of utm_content query param.

utm_medium#

TypeFilterableCan change?
String
Value of utm_medium query param.

utm_source#

TypeFilterableCan change?
String
Value of utm_source query param.

utm_term#

TypeFilterableCan change?
String
Value of utm_term query param.

visits_count#

TypeFilterableCan change?
Integer
Number of how many times link was resolved.
Visits done by bots are not included.

unique_visits_count#

TypeFilterableCan change?
Integer
Number of how many members visited the link.
Visits done by bots are not included.

Query without aggregations#

Query returns list of sendings.
{
    "records": [
        {
            "loyalty_club_id": 42,
            "source_id": "7383",
            "host": "example.com",
            "path": "/an_example",
            "utm_campaign": null,
            "utm_content": null,
            "utm_medium": null,
            "utm_source": null,
            "utm_term": null,
            "visits_count": 8925,
            "unique_visits_count": 191
        }
    ],
    "pagination": {
        "next_page_info": "KgkRAAAAAHP-M0E"
    },
    "result_type": "records"
}
Previous
sendings_recipients_statistics (timeseries)
Next
sendings_links_stats (records)
Built with