Parllay Insights API - ParllaySocial/parllay-php-sdk GitHub Wiki
Parllay Insights API
Currently, we only open the insights data for listener
We have 2 categories for listener insights data:
- listener
- listener_drilldown
For category listener, we have 19 metrics as follows:
- channel_distribution
- channel_distribution_by_keyword
- city_distribution
- city_sentiment_distribution,
- country_distribution
- country_sentiment_distribution
- conversation_cluster
- demographic_gender,
- emotion_distribution
- klout_score
- purchase_intent
- purchase_intent_by_keyword,
- sentiment_distribution,
- sentiment_keyword_distribution
- sentiment_score
- top_influencers
- top_hashtags,
- top_links
- topic_cloud
For category listener_drilldown, we have 7 metrics:
- channel_distribution_drilldown
- city_distribution_drilldown
- country_distribution_drilldown
- demographic_gender_drilldown
- purchase_intent_drilldown
- sentiment_distribution_drilldown
- sentiment_score_drilldwon
Parameters for listener insights data
- profile_id: This parameter is mandatory, the listener profile id, you can learn how to get profile information from Get listener-profile-of-one-business
- category: This parameter is mandatory, the available value are: listener or listener_drilldown
- keyword_group: This parameter is mandatory, it is a keyword group array, you must specify at least one keyword group, you can learn how to get keyword group from Get listener-profile-of-one-business
- metrics: This parameter is optional, you can specify multiple metrics at same time, the metrics are separated by commas, and the specified metrics must belong to the specified category.
- kind: This parameter is optional, the available value are: day, week, month, if not specify, the default value is day.
- since: This parameter is optional, the value should be one available date, if not specify, the default value is now.
- until: This parameter is optional, the value should be one available date, if not specify, the default value is the value of parameter since.
For usage of Parllay Listener Insights, please visit Get insights data for listener