Skip to main content
POST
get-campaign-statistics
Data availabilityCheck the previous day’s data after 7 a.m. KST.
Aggregation datesDaily data is aggregated and reported by the date each event occurs. For example, if a campaign is sent on July 23 and a click occurs on July 24, the send event counts toward July 23 and the click event counts toward July 24.
Difference from detailed message statisticsDetailed message statistics requires a specific campaign. This API provides daily counts for campaigns and user journeys aggregated over the requested period. If you specify tags, the response includes only campaigns that match any of the specified tags and excludes user journeys.

Authorizations

Authorization
string
header
required

Pass the token issued by POST /authenticate as a bearer token.

Path Parameters

projectId
string
required

Project ID.

Body

application/json
start
string<date>
required

First date to query in yyyy-MM-dd format, in KST.

end
string<date>
required

Last date to query in yyyy-MM-dd format, in KST. The current date is excluded.

tags

Campaign tags as an array or a comma-separated string. Any tag may match. The filter excludes user journeys.

Response

Statistics retrieved.

date
string<date>

The date of the statistics in YYYY-MM-DD format.

resource_type
enum<string>

The resource type.

Available options:
campaign,
user_journey
message
object | null

The message content. The structure differs by channel.

campaign_id
string | null

The campaign ID. Present only for campaign resources.

campaign_name
string | null

The campaign name. Present only for campaign resources.

variant_id
string | null

The campaign’s A/B test variant ID, or null if the campaign row has no variant ID.

variant_name
string | null

The campaign’s A/B test variant name, or null if the campaign row has no variant name.

tags
string[]

The list of campaign tags.

user_journey_id
string | null

The user journey ID. Present only for user journey resources.

user_journey_name
string | null

The user journey name. Present only for user journey resources.

user_journey_node_id
string | null

The user journey node ID. Present only for user journey resources.

user_journey_node_name
string | null

The user journey node name. Present only for user journey resources.

channel
string

The delivery channel information.

channel_subtype
string | null

Messaging channel subtype.

brand_message_target
string | null

Kakao Brand Message target.

message_sent
integer | null

Successful sends. For popups, impressions. Null when the channel does not support the metric.

message_failed
integer | null

Failed sends. Null when the channel does not support the metric.

delivered
integer | null

The number of delivered messages. null if the channel does not support this metric.

click
integer | null

The number of clicked messages. null if the channel does not support this metric.

conversion
object[]

The array of conversion data.