Chart aggregates and dimensions

On this page we will show:

For example calls, please refer to the examples on the previous page.

Dimensions

General dimensions

Dimension	Function
`queries`	Chart by the queries that mentions are stored in. Use when passing through specific Query IDs.
`sentiment`	Chart by the sentiment of the mentions.
`queryGroups`	Chart by the query groups that mentions are stored in. Use when passing through specific Query Group IDs.
`authors`	Chart by the authors that posted the mentions.
`languages`	Chart by the language of the mentions.

Workflow dimensions

Dimension	Function	Args
`categories`	Chart by the categories applied to mentions.	Optionally `dimXArgs` can be used to specify the category ids a user wants to include in the breakdown. Can be specified multiple times in the query parameters- e.g. `dim1Args=1&dim1Args=2`. A category id of `-1` can be specified to include uncategorised mentions in the breakdown. If not present all categories that have been applied to the mentions are returned.
`parentCategories`	Chart by the parent categories applied to mentions.	n/a
`mixedCategories`	Chart by both parent and subcategories applied to mentions (e.g to compare subcategories from different parent categories).	n/a
`tags`	Chart by the tags that have been applied.	Optionally `dimXArgs` can be used to specify the tags a user wants to include in the breakdown. Can be specified multiple times in the query parameters- e.g. `dim1Args=myTag1&dim1Args=myTag2`. A tag name of `-1` can be specified to include untagged mentions in the breakdown. If not present all tags that have been applied to the mentions are returned.
`assignment`	Chart by the users that mentions are assigned to.	n/a
`checked`	Chart by whether mentions have been checked or not.	n/a
`priority`	Chart by the priority assigned to a mention.	n/a
`status`	Chart by the status assigned to mentions.	n/a

Location dimensions

Dimension	Function
`authorContinents`	Deprecated
`authorCountries`	Deprecated
`authorStates`	Deprecated
`authorCounties`	Deprecated
`authorCities`	Deprecated
`continents`	Chart by the continent a mention was posted from.
`countries`	Chart by the country a mention was posted from.
`states`	Deprecated
`counties`	Deprecated
`cities`	Chart by the city a mention was posted from.
`regions`	Chart by the region a mention was posted from.

Time dimensions

Dimension	Function
`months`	Chart by the months that mentions were from.
`weeks`	Chart by the weeks that mentions were from.
`days`	Chart by the days that mentions were from.
`hours`	Chart by the hours that mentions were from.
`minutes`	Chart by the minutes that mentions were from.
`hourOfDay`	Chart by the hour of day that mentions were from.
`dayOfWeek`	Chart by the day of week that mentions were from.

Demographic dimensions

Please note: these are currently for Twitter data only.

Dimension	Function
`accountTypes`	Chart by the account type that mentions were posted from.
`gender`	Chart by the gender of the account that mentions were posted from.
`interest`	Chart by the interests of the account that mentions were posted from.
`profession`	Chart by the professions of the account that mentions were posted from.

Site dimensions

Dimension	Function
`pageTypes`	Chart by the page type of the site that mentions were posted from.
`domains`	Chart by the domain of the site that mentions were posted from.

Reddit dimensions

Dimension	Function	Args	Limit
`subreddits`	Chart by the top subreddits that mentions were posted in.	Optionally `dimXArgs` can be used to determine the aggregate used for defining the "top" subreddits, by default it is volume, however it could be any other aggregate.	Optionally `dimXLimit` can be used to determine how many top subreddits should be included in the chart- default is 10, max is 100.

General aggregates

Aggregate	Function
`volume`	Aggregate by the volume of mentions.
`authors`	Aggregate by the authors of the mentions.
`blogComments`	Deprecated
`domains`	Aggregate by the domain that mentions are from.
`forumPosts`	Deprecated
`forumViews`	Deprecated
`impressions`	Aggregate by impressions.
`influence`	Deprecated
`netSentiment`	Aggregate by net sentiment score (-5 to +5).
`outreach`	Deprecated
`reach`	Deprecated
`reachEstimate`	Aggregate by the estimated reach.
`twitterFollowers`	Aggregate by number of Twitter followers.
`twitterLikeCount`	Aggregate by number of Twitter likes
`redditScore`	Aggregate by net Reddit Score
`redditAuthorKarmaMin`	Aggregate by minimum Reddit Author Karma
`redditAuthorKarmaMax`	Aggregate by maximum Reddit Author Karma
`subreddits`	Aggregate by the total unique subreddits
`engagementScore`	Aggregate by the total engagement score