API OverviewAPI Reference
developer.placewise.comapp.placewise.complacewise.com
API OverviewAPI Reference
developer.placewise.comapp.placewise.complacewise.com
IndexPublic APIManagement APIUsers APIOperations APIMessaging APIReporting API
ML APIData API
IndexPublic APIManagement APIUsers APIOperations APIMessaging APIReporting API
ML APIData API
  1. Sendings
  • Introduction
  • Filter parameter specification
  • Data formats
    • Records
    • Timeseries
    • Statistics
  • 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)
      • sendings_stats (statistics)
      • Examples
        • sendings - find sending by reporting_id
        • sendings_events_history - show sending events
        • sendings_recipients_statistics - show recipients by age groups
        • sendings_stats - show statistics for campaign
        • sendings_events_history - show sending events for campaign
        • sendings_stats - show statistics for all campaigns
        • sendings_events_history - show sending events for all campaigns
    • Links
      • links_visits_history (timeseries)
    • Offers
      • offers (records)
      • offers_collections (records)
      • offers_events_history (timeseries)
      • offers_usages_history (timeseries)
      • offers_events_stats (statistics)
      • offers_usages_stats (statistics)
    • Transactions
  • 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_stats (statistics)

Required permitRate limit tokens cost
Reporting:Api:Report:SendingsStats2
This report allows you to get statistics which are produced during sending.
It includes events which are common for each available channel.

Fields#

loyalty_club_id#

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

event_type#

TypeFilterable
Enum
Type of sendings event.
This field is an enum, possible values are:
new
transmitted
transiently_failed
delivered
opened
opened_event
failed
delivery_errored

channel#

TypeFilterable
EnumDepends on aggregation
Channel of sending.
This field is an enum, possible values are:
sms
email
push

service_type#

TypeFilterable
EnumDepends on aggregation
Sending's service type.

campaign_id#

TypeFilterable
IntegerDepends on aggregation
ID of campaign to which sending was scheduled.

reporting_id#

TypeFilterable
IntegerDepends on aggregation
Sending's reporting_id. This field can be used to attribute reported sending to its source.

Query without aggregations#

Query returns series with sending events labeled by event_type.

Labels#

KeyTypeDescription
event_typeEnumSee in Fields

Aggregations#

service_type#

Labels#

KeyTypeDescription
service_typeEnumSee in Fields
event_typeEnumSee in Fields
NOTE
There is also total_service_type aggregation which works the same way but removes loyalty_club_id from series when working on cross-customer data.

campaign_id#

Labels#

KeyTypeDescription
campaign_idIntegerSee in Fields
event_typeEnumSee in Fields
NOTE
There is also total_campaign_id aggregation which works the same way but removes loyalty_club_id from series when working on cross-customer data.

channel#

Labels#

KeyTypeDescription
channelEnumSee in Fields
event_typeEnumSee in Fields
NOTE
There is also total_channel aggregation which works the same way but removes loyalty_club_id from series when working on cross-customer data.

reporting_id#

Labels#

KeyTypeDescription
reporting_idIntegerSee in Fields
event_typeEnumSee in Fields
NOTE
There is also total_reporting_id aggregation which works the same way but removes loyalty_club_id from series when working on cross-customer data.
Previous
sendings_links_stats (records)
Next
sendings - find sending by reporting_id
Built with