Sprinklr: Most-used fields

Sprinklr: Most-used fields#

The table below gives information about most-used fields that you can import from Sprinklr. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

Age

Age

The age demographic of the audience interacting with content or ads.

dimension

CAMPAIGN_ID_DIMENSION

CAMPAIGN_ID_DIMENSION

A dimension representing the unique identifier for a marketing campaign.

dimension

D_ACCOUNTUSERID_{NUM}

D_ACCOUNTUSERID_{NUM}

A unique identifier for a user associated with a social media account managed within Sprinklr. This is a dimension used for categorization.

dimension

D_PIENDDATE_{NUM}

D_PIENDDATE_{NUM}

The end date of the requested query for a paid initiative or post insight.

dimension

D_PISTARTDATE_{NUM}

D_PISTARTDATE_{NUM}

The start date of the requested query for a paid initiative or post insight.

dimension

Facebook Region

Facebook Region

The geographic region associated with Facebook activity or ad targeting.

dimension

GATING_ENABLED

GATING_ENABLED

Indicates whether content or access is restricted or ‘gated’ based on specific criteria.

dimension

Gender

Gender

The gender demographic of the audience interacting with content or ads.

dimension

IS_DARK_POST

IS_DARK_POST

Indicates whether a post is a ‘dark post’ (an unpublished ad targeting specific audiences).

dimension

IS_DELETED

IS_DELETED

Indicates whether a message or post has been deleted from the social network.

dimension

IS_GIF

IS_GIF

Indicates whether the content of a post is a GIF.

dimension

IS_IGTV_POST

IS_IGTV_POST

Indicates whether the content is an IGTV post on Instagram.

dimension

IS_IG_REEL_POST

IS_IG_REEL_POST

Indicates if an Instagram post is a Reel.

dimension

IS_LIVE_VIDEO

IS_LIVE_VIDEO

Indicates whether the content is a live video broadcast.

dimension

IS_SPONSORED

IS_SPONSORED

Indicates whether the content is sponsored (i.e., paid promotion).

dimension

Lifetime_Budget

Lifetime_Budget

The total budget allocated for an ad campaign over its entire duration.

metric

MEDIA_TYPE

MEDIA_TYPE

The type of media included in the post, such as Photo, Video, Link, Album, or Text.

dimension

M_DAILY_AD_REPORT_STAT_ACTIONSREPORTABLE_ACTIONTYPEVALUEMAP_LINK_CLICK_{NUM}

M_DAILY_AD_REPORT_STAT_ACTIONSREPORTABLE_ACTIONTYPEVALUEMAP_LINK_CLICK_{NUM}

The number of link clicks for ads in a daily ad report.

metric

M_DAILY_AD_REPORT_STAT_ACTIONSREPORTABLE_ACTIONTYPEVALUEMAP_MOBILE_APP_INSTALL_{NUM}

M_DAILY_AD_REPORT_STAT_ACTIONSREPORTABLE_ACTIONTYPEVALUEMAP_MOBILE_APP_INSTALL_{NUM}

The number of mobile app installs attributed to ads in a daily ad report.

metric

M_DAILY_AD_REPORT_STAT_IMPRESSIONS_{NUM}

M_DAILY_AD_REPORT_STAT_IMPRESSIONS_{NUM}

The total number of times an ad was shown in a daily ad report.

metric

M_DAILY_AD_REPORT_STAT_SPENT_{NUM}

M_DAILY_AD_REPORT_STAT_SPENT_{NUM}

The total amount of money spent on ads in a daily ad report.

metric

M_DAILY_AD_STAT_ACTIONSREPORTABLE_ACTIONTYPEVALUEMAP_APP_INSTALL_{NUM}

M_DAILY_AD_STAT_ACTIONSREPORTABLE_ACTIONTYPEVALUEMAP_APP_INSTALL_{NUM}

The number of app installs attributed to ads.

metric

M_DAILY_AD_STAT_ACTIONSREPORTABLE_ACTIONTYPEVALUEMAP_MOBILE_APP_INSTALL_{NUM}

M_DAILY_AD_STAT_ACTIONSREPORTABLE_ACTIONTYPEVALUEMAP_MOBILE_APP_INSTALL_{NUM}

The number of mobile app installs attributed to ads.

metric

M_DAILY_AD_STAT_BY_DMA_CLICKS_{NUM}

M_DAILY_AD_STAT_BY_DMA_CLICKS_{NUM}

The number of clicks on ads, broken down by Designated Market Area (DMA).

metric

M_DAILY_AD_STAT_BY_DMA_IMPRESSIONS_{NUM}

M_DAILY_AD_STAT_BY_DMA_IMPRESSIONS_{NUM}

The number of ad impressions, broken down by Designated Market Area (DMA).

metric

M_DAILY_AD_STAT_BY_DMA_SPENTINUSD_{NUM}

M_DAILY_AD_STAT_BY_DMA_SPENTINUSD_{NUM}

The amount spent on ads in USD, broken down by Designated Market Area (DMA).

metric

M_DAILY_AD_STAT_BY_DMA_SPENT_{NUM}

M_DAILY_AD_STAT_BY_DMA_SPENT_{NUM}

The total amount spent on ads, broken down by Designated Market Area (DMA).

metric

M_DAILY_AD_STAT_BY_REGION_CLICKS_{NUM}

M_DAILY_AD_STAT_BY_REGION_CLICKS_{NUM}

The number of clicks on ads, broken down by geographical region.

metric

M_DAILY_AD_STAT_BY_REGION_IMPRESSIONS_{NUM}

M_DAILY_AD_STAT_BY_REGION_IMPRESSIONS_{NUM}

The number of ad impressions, broken down by geographical region.

metric

M_DAILY_AD_STAT_BY_REGION_SPENT_{NUM}

M_DAILY_AD_STAT_BY_REGION_SPENT_{NUM}

The total amount spent on ads, broken down by geographical region.

metric

M_DAILY_AD_STAT_OFFSITECONVERSIONPURCHASEFBPIXEL_{NUM}

M_DAILY_AD_STAT_OFFSITECONVERSIONPURCHASEFBPIXEL_{NUM}

Daily count of offsite purchase conversions attributed to ads, as tracked by Facebook Pixel.

metric

M_DAILY_AD_STAT_PINTEREST_APPINSTALLS_{NUM}

M_DAILY_AD_STAT_PINTEREST_APPINSTALLS_{NUM}

Daily number of app installs attributed to Pinterest ads.

metric

M_DAILY_AD_STAT_PINTEREST_PAIDAPPINSTALLSVIEWS_{NUM}

M_DAILY_AD_STAT_PINTEREST_PAIDAPPINSTALLSVIEWS_{NUM}

Daily number of views of Pinterest ads that resulted in paid app installs.

metric

M_DAILY_AD_STAT_SNAPCHAT_TOTALINSTALLS_{NUM}

M_DAILY_AD_STAT_SNAPCHAT_TOTALINSTALLS_{NUM}

Daily total number of app installs attributed to Snapchat ads.

metric

M_DAILY_AD_STAT_SPENT_{NUM}

M_DAILY_AD_STAT_SPENT_{NUM}

The total amount of money spent on ads.

metric

M_DAILY_AD_STAT_TARGETACTIONS_{NUM}

M_DAILY_AD_STAT_TARGETACTIONS_{NUM}

Daily count of target actions achieved by an advertisement.

metric

POST_FB_CONSUMPTIONS_BY_TYPE_LINK_CLICKS

POST_FB_CONSUMPTIONS_BY_TYPE_LINK_CLICKS

The total number of link clicks on a Facebook post, categorized by consumption type.

metric

POST_FB_IMPRESSIONS

POST_FB_IMPRESSIONS

The total number of times a Facebook post was displayed to users.

metric

POST_FB_IMPRESSIONS_ORGANIC

POST_FB_IMPRESSIONS_ORGANIC

The number of times a Facebook post was displayed to users through organic reach.

metric

POST_FB_IMPRESSIONS_PAID

POST_FB_IMPRESSIONS_PAID

The number of times a Facebook post was displayed to users through paid advertising.

metric

POST_FB_IMPRESSIONS_UNIQUE

POST_FB_IMPRESSIONS_UNIQUE

The number of unique people who were shown a Facebook post.

metric

POST_FB_STORIES_BY_ACTION_TYPE_COMMENT

POST_FB_STORIES_BY_ACTION_TYPE_COMMENT

The number of comments on Facebook stories.

metric

POST_FB_STORIES_BY_ACTION_TYPE_LIKE

POST_FB_STORIES_BY_ACTION_TYPE_LIKE

The number of likes on Facebook stories.

metric

POST_FB_STORIES_BY_ACTION_TYPE_SHARE

POST_FB_STORIES_BY_ACTION_TYPE_SHARE

The number of shares of Facebook stories.

metric

POST_FB_VIDEO_AVG_TIME_WATCHED

POST_FB_VIDEO_AVG_TIME_WATCHED

The average time users spent watching a Facebook video.

metric

POST_FB_VIDEO_COMPLETE_VIEWS_30S

POST_FB_VIDEO_COMPLETE_VIEWS_30S

The number of times a Facebook video was viewed for at least 30 seconds (considered a complete view).

metric

POST_FB_VIDEO_COMPLETE_VIEWS_30S_ORGANIC

POST_FB_VIDEO_COMPLETE_VIEWS_30S_ORGANIC

The number of times an organic Facebook video was viewed for at least 30 seconds.

metric

POST_FB_VIDEO_COMPLETE_VIEWS_30S_PAID

POST_FB_VIDEO_COMPLETE_VIEWS_30S_PAID

The number of times a paid (promoted) Facebook video was viewed for at least 30 seconds.

metric

POST_FB_VIDEO_LENGTH

POST_FB_VIDEO_LENGTH

The categorized duration of a Facebook video post.

metric

POST_FB_VIDEO_VIEWS

POST_FB_VIDEO_VIEWS

The total number of times a Facebook video post was viewed.

metric

POST_FB_VIDEO_VIEWS_10S

POST_FB_VIDEO_VIEWS_10S

The number of times a Facebook video was viewed for at least 10 seconds.

metric

POST_FB_VIDEO_VIEWS_10S_ORGANIC

POST_FB_VIDEO_VIEWS_10S_ORGANIC

The number of times an organic Facebook video was viewed for at least 10 seconds.

metric

POST_FB_VIDEO_VIEWS_10S_PAID

POST_FB_VIDEO_VIEWS_10S_PAID

The number of times a paid (promoted) Facebook video was viewed for at least 10 seconds.

metric

POST_FB_VIDEO_VIEWS_ORGANIC

POST_FB_VIDEO_VIEWS_ORGANIC

The total number of organic views for a Facebook video.

metric

POST_FB_VIDEO_VIEWS_PAID

POST_FB_VIDEO_VIEWS_PAID

The total number of paid (promoted) views for a Facebook video.

metric

POST_FB_VIDEO_VIEW_TIME

POST_FB_VIDEO_VIEW_TIME

The total accumulated time users spent watching a Facebook video.

metric

POST_FB_VIDEO_VIEW_TIME_ORGANIC

POST_FB_VIDEO_VIEW_TIME_ORGANIC

The total accumulated time users spent watching an organic Facebook video.

metric

POST_FB_VIDEO_VIEW_TIME_PAID

POST_FB_VIDEO_VIEW_TIME_PAID

The total accumulated time users spent watching a paid (promoted) Facebook video.

metric

POST_ID

POST_ID

The unique identifier for a post.

dimension

POST_PART_OF_MULTI_PHOTO

POST_PART_OF_MULTI_PHOTO

Indicates whether a post is part of a multi-photo (carousel) album.

dimension

POST_PUBLISHED_DATE

POST_PUBLISHED_DATE

The exact date when the post was published.

dimension

POST_VIDEO_DURATION

POST_VIDEO_DURATION

The duration of the video attached to a post.

metric

Region

Region

A geographic region associated with the data.

dimension

SN_MESSAGE_TYPE

SN_MESSAGE_TYPE

The type of message posted on a social network, such as text, image, video, or link.

dimension

SN_TYPE

SN_TYPE

The type of social network where the post originated (e.g., Facebook, Instagram, Twitter).

dimension

accountIds

accountIds

Sprinklr’s internal ID numbers associated with social media accounts.

dimension

accountIds_{NUM}

accountIds_{NUM}

Sprinklr’s internal ID numbers associated with social media accounts. The {NUM} suffix indicates a potential for multiple account IDs or time-series data.

dimension

accountSprinklrIds_{NUM}

accountSprinklrIds_{NUM}

Sprinklr’s internal ID numbers associated with social media accounts. The {NUM} suffix indicates a potential for multiple account IDs or time-series data.

metric

accountUserId

accountUserId

The unique identifier for a user account, particularly a social network user ID associated with an ad account. This helps in understanding data linked to specific user profiles.

metric

account_id

account_id

The internal Sprinklr ID number associated with the Account.

dimension

account_id_sprinklr

account_id_sprinklr

The internal Sprinklr ID number associated with the Account.

dimension

account_name

account_name

The name of the social network account.

dimension

actionscomment

actionscomment

A metric representing the total number of comments received on posts or content across social networks.

metric

actionslanding_page_view

actionslanding_page_view

The number of times a landing page was viewed as a result of an action.

metric

actionslike

actionslike

A metric representing the total number of likes and reactions received on posts or content across social networks.

metric

actionspost

actionspost

Aggregate of actions performed on a post, such as likes, comments, and shares.

metric

actionspost_engagement

actionspost_engagement

A metric representing the total engagement received on posts, including likes, comments, and shares.

metric

actionsvideo_view

actionsvideo_view

A metric representing the total number of video views.

metric

adChannel

adChannel

The advertising channel or platform used for an ad (e.g., Facebook, Instagram, LinkedIn).

dimension

adChannelId_{NUM}

adChannelId_{NUM}

The unique identifier for the advertising channel.

metric

adName_{NUM}

adName_{NUM}

The name of a specific advertisement. This field categorizes data by individual ad campaigns or creatives.

dimension

adSetId

adSetId

The identifier for an ad set, which is a group of ads that share settings for targeting, scheduling, and bidding.

dimension

adSetId_{NUM}

adSetId_{NUM}

The identifier for an ad set, which is a group of ads that share settings for targeting, scheduling, and bidding. The {NUM} suffix indicates a potential for multiple ad set IDs or time-series data.

dimension

adSetSprinklrId_{NUM}

adSetSprinklrId_{NUM}

Sprinklr’s internal identifier for an ad set, which is a group of ads that share settings for targeting, scheduling, and bidding. The {NUM} suffix indicates a potential for multiple ad set IDs or time-series data.

dimension

adVariantSprinklrId_{NUM}

adVariantSprinklrId_{NUM}

The unique Sprinklr identifier for a specific ad variant.

dimension

ad_id

ad_id

The unique identifier for an advertisement.

dimension

ad_name

ad_name

The name given to an advertisement.

dimension

adset_id

adset_id

The identifier for an ad set, which is a group of ads that share settings for targeting, scheduling, and bidding.

dimension

adset_name

adset_name

The name of an ad set, which is a group of ads with similar targeting, budget, and schedule.

dimension

age_{NUM}

age_{NUM}

The age demographic of the audience interacting with content or ads.

dimension

campaign_id

campaign_id

The unique identifier for a marketing campaign.

dimension

campaign_name

campaign_name

The name of the marketing campaign.

dimension

channelCampaignId

channelCampaignId

The identifier for a campaign within a specific social or advertising channel.

dimension

channelCampaignId_{NUM}

channelCampaignId_{NUM}

The unique identifier for a campaign within a specific advertising channel.

dimension

city

city

The city from which an interaction or event originated.

dimension

clicks

clicks

The total number of clicks on an ad or content. This metric provides an estimated number of clicks on posts.

metric

clicks@all

clicks@all

The total number of clicks across all social media channels.

metric

clientId

clientId

The unique identifier for the client in the Sprinklr platform.

dimension

clientName

clientName

The name of the client or organization associated with the data. Used for grouping and filtering data by client.

dimension

comments@meta

comments@meta

The total number of comments received on posts or content on Meta platforms (Facebook, Instagram).

metric

comments@tiktok

comments@tiktok

The number of comments received on TikTok content.

metric

currency

currency

The currency used for reporting financial metrics related to advertising.

dimension

date

date

The specific date for which the reporting data is recorded.

dimension

date_start

date_start

The start date for the reporting period.

dimension

engagements@meta

engagements@meta

The total engagement (likes, comments, shares) received on posts or content on Meta platforms (Facebook, Instagram).

metric

facebook_region

facebook_region

The geographic region associated with Facebook activity or ad targeting.

dimension

follows@tiktok

follows@tiktok

The number of new followers gained on TikTok.

metric

gender_{NUM}

gender_{NUM}

The gender demographic of the audience interacting with content or ads.

dimension

impressions

impressions

The total number of times an ad or content was displayed.

metric

impressions@all

impressions@all

The total number of times content was displayed across all social media channels.

metric

inline_link_clicks

inline_link_clicks

The number of clicks on links within the ad creative itself, rather than external calls-to-action.

metric

likes@meta

likes@meta

The total number of likes received on posts or content on Meta platforms (Facebook, Instagram).

metric

likes@tiktok

likes@tiktok

The number of likes received on TikTok content.

metric

link_clicks@meta

link_clicks@meta

The number of clicks on links within content or ads on Meta platforms.

metric

measurementTime_{NUM}

measurementTime_{NUM}

The timestamp indicating when a metric was measured.

metric

metrics

metrics

A collection of numerical measurements that quantify performance, such as engagement rate, reach, and impressions.

metric

pageviews@meta

pageviews@meta

The number of page views on Meta platforms, often related to Facebook pages or profiles.

metric

pageviews@snapchat

pageviews@snapchat

The total number of page views received on content published on Snapchat.

metric

paidInitiativeChannelId

paidInitiativeChannelId

The unique identifier for the channel used in a paid advertising initiative.

dimension

paidInitiativeChannelId_{NUM}

paidInitiativeChannelId_{NUM}

The unique identifier for the channel used in a paid advertising initiative.

dimension

paidInitiativeId

paidInitiativeId

The identifier for a specific paid initiative or advertisement campaign.

dimension

paidInitiativeId_{NUM}

paidInitiativeId_{NUM}

The unique identifier for a paid advertising initiative or campaign.

dimension

paidInitiativeSprinklrId_{NUM}

paidInitiativeSprinklrId_{NUM}

The unique Sprinklr identifier for a paid advertising initiative or campaign.

dimension

post_reaction_like

post_reaction_like

The total number of ‘like’ reactions received on a post.

metric

purchases_total@meta

purchases_total@meta

The total number of purchases attributed to activity on Meta platforms.

metric

purchasesapp@snapchat

purchasesapp@snapchat

The number of in-app purchases attributed to Snapchat activity.

metric

purchasesweb@snapchat

purchasesweb@snapchat

The number of web purchases attributed to Snapchat activity.

metric

reportingEnds_{NUM}

reportingEnds_{NUM}

The end date for the reporting period.

dimension

reportingStarts_{NUM}

reportingStarts_{NUM}

The start date for the reporting period.

dimension

results

results

An array containing the individual data records or rows returned by the reporting API query.

metric

results@all

results@all

A general metric representing the overall outcome or performance across all integrated platforms.

metric

segmentedAdDma_{NUM}

segmentedAdDma_{NUM}

A Designated Market Area (DMA) used for segmenting ad performance data.

dimension

segmentedAdRegion_{NUM}

segmentedAdRegion_{NUM}

A geographic region used for segmenting ad performance data.

dimension

shares@meta

shares@meta

The total number of shares received on posts or content on Meta platforms (Facebook, Instagram).

metric

shares@snapchat

shares@snapchat

The number of times content was shared on Snapchat.

metric

shares@tiktok

shares@tiktok

The number of shares for a TikTok video post.

metric

spend

spend

The total amount of money spent on an advertising campaign or paid initiative.

metric

spend@all

spend@all

The total amount of money spent on advertising across all social media channels.

metric

spend_usd@all

spend_usd@all

The total amount of money spent on advertising across all social media channels, converted to USD.

metric

storyopens@snapchat

storyopens@snapchat

The number of times a Snapchat story was opened.

metric

video_p100_watched_actions

video_p100_watched_actions

The number of times a video was watched to 100% completion.

metric

video_p25_watched_actions

video_p25_watched_actions

The number of times a video was watched to at least 25% completion.

metric

video_p50_watched_actions

video_p50_watched_actions

The number of times a video was watched to at least 50% completion.

metric

video_p75_watched_actions

video_p75_watched_actions

The number of times a video was watched to at least 75% completion.

metric

video_p95_watched_actions

video_p95_watched_actions

The number of times a video was watched to at least 95% completion.

metric

videocompletes@meta

videocompletes@meta

The number of times a video was watched to completion on Meta platforms (Facebook, Instagram).

metric

videocompletes@snapchat

videocompletes@snapchat

The number of times a video was watched to 100% completion on Snapchat.

metric

videocompletes@tiktok

videocompletes@tiktok

The number of times a video was watched to 100% completion on TikTok.

metric

videoviews@meta

videoviews@meta

The total number of video views on Meta platforms (Facebook, Instagram).

metric

videoviews@snapchat

videoviews@snapchat

The total number of video views on Snapchat.

metric

videoviews@tiktok

videoviews@tiktok

The total number of video views on TikTok.

metric