Show billing breakdown

Groups per grouping type

Grouping	Group
purpose	campaigns, other
campaign	id of the campaign
channel	sms, email, push, number_lookup
country_code	2 letter code of the country (ex. NO, PL)
service_message	"generic", "tbp_direct_member_messages", "campaigns", "triggers", "tenants", "now_trending", "campaigns_testing", "tenants_testing", "rewards_notifications", "keywords_service_messages", "ekorts", "marketplace_notifications", "program_registration_messages", "login_passwords", "registration_passwords", "welcome_messages", "optins", "optouts", "email_verification_messages", "reset_password_messages", "already_member_messages", "help_messages", "unsub_messages", "msisdn_verification_messages", "verification_success_messages", "app_admin_notifications", "sending_reminder_notifications", "sending_sent_notifications", "sending_error_notifications", "sending_delivery_lagging_notifications", "sending_delivery_failing_notifications", "members_import_finished_notifications", "members_export_finished_notifications", "member_export_finished_notifications", "games_support_messages", "games_internal_messages", "conversation_message_received_notifications", "accounting_threshold_exceeded_notifications", "customer_domain_became_verified_notifications", "customer_domain_became_unverified_notifications", "email_domain_became_valid_notifications", "email_domain_became_invalid_notifications", "web_domain_setup_became_valid_notifications", "web_domain_setup_became_invalid_notifications", "user_auth_invite_messages", "user_auth_reset_password_messages", "user_auth_login_error_notifications", "user_auth_otp_added_notifications", "user_auth_otp_removed_notifications", "user_auth_password_updated_notifications", "user_auth_email_updated_notifications", "user_auth_otp_code_email_mfa_messages", "user_auth_otp_code_sms_mfa_messages", "user_auth_otp_code_email_verification_messages", "user_auth_otp_code_msisdn_verification_messages", "user_auth_unfinished_registration_messages", "legacy_site_notifications", "tem_documents_without_confirmation", "tem_documents_with_confirmation", "tem_documents", "tem_documents_reminders", "tem_resources_reminders", "tem_resources_accepted_notifications", "tem_resources_rejected_notifications", "tem_resources_destroyed_notifications", "tem_alerts", "tem_alerts_requests_notifications", "tem_alerts_recalls", "tem_abm_links_notifications", "tem_issues_created_notifications", "tem_issues_updated_notifications", "tem_issues_accepted_notifications", "tem_issues_resolved_notifications", "rewards_points_expirations_notifications"

Possible groupings for type

type	possible grouping
sms	purpose, campaign, service_message, country_code
email	purpose, campaign, service_message
push	purpose, campaign, service_message
null	purpose, channel

Request

Query Params

period

enum<string>

optional

Length of period for breakdown. If provided requires offset param. If not provided will return all time yearly breakdown.

Allowed values:

monthyear

Example:

month

offset

integer

optional

Offset from the current date in period unit. If provided requires period param.

>= 0

Example:

type

enum<string>

optional

Type of messages

Allowed values:

smsemailpush

Example:

sms

grouping

enum<string>

optional

Group types that the period will be divided into

Allowed values:

purposecampaignchannelservice_messagecountry_code

Example:

purpose

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

total

array [object {3}]

required

group

string

required

count

integer

required

cost

string

required

breakdown

array [object {2}]

required

period

string

optional

data

array [object {3}]

optional

Examples

Success - grouping by purposeSuccess - grouping by channel

{
  "total": [
    {
      "group": "total",
      "count": 2,
      "cost": "10.0"
    },
    {
      "group": "campaigns",
      "count": 1,
      "cost": "5.0"
    },
    {
      "group": "other",
      "count": 1,
      "cost": "5.0"
    }
  ],
  "breakdown": [
    {
      "period": "01.05.2024",
      "data": [
        {
          "group": "total",
          "count": 2,
          "cost": "10.0"
        },
        {
          "group": "camapigns",
          "count": 1,
          "cost": "5.0"
        },
        {
          "group": "other",
          "count": 1,
          "cost": "5.0"
        }
      ]
    }
  ]
}

🟠422Parameter Error

Groups per grouping type#

Possible groupings for type#

Request

Request samples

Responses

Groups per grouping type

Possible groupings for type