API ReferenceInsights

Top audience segments by location

Returns the most-represented audience segments for a given location, ranked by video count. Pass a location ID to get top attributes for that location. Pass an attribute ID (without a location) to get the top countries for that attribute, or combine with a location ID to narrow the scope.

Authentication

x-api-keystring
API key issued with your NaviSavi plan

Query parameters

country_idintegerOptional

Country ID - determines country-level results

region_idintegerOptional

Region ID - determines region-level results

locality_idintegerOptional

Locality ID - determines locality-level results

seasonenumOptionalDefaults to all
Filter by season. Defaults to all.
Allowed values:
limitintegerOptional1-25Defaults to 10

Number of results to return (max 25)

audience_segment_idintegerOptional

Reverse direction: returns top locations for this audience segment instead of top segments for a location

Response

Top audience segments
audienceSegmentIdinteger
audienceSegmentNamestring
audienceSegmentSlugstring
countryIdinteger
countryNamestring
regionIdinteger or null
regionNamestring or null
localityIdinteger or null
localityNamestring or null
seasonstring
videoCountinteger

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error