Enterprise
Enterprise enrichments are additive metadata included in the response payload of some of the data APIs. They are available in paid subscription plans only.
The table below offers a brief description of each enrichment:
Enrichment: | Description: |
---|---|
Expanded and Enhanced URLs | Automatically expands shortened URLs (e.g., bitly) that are included in the body of a Post and provides HTML Title and Description metadata from the destination page. |
Matching rules object | Indicates which rule or rules matched the Posts received. The object returns rule tag and rule ID in the response object. |
Poll metadata | Notes the presence of the poll in a Post, includes the list of poll choices, and includes both the poll duration and expiration time. |
Profile geo | Derived user profile location data including the [longitude, latitude] coordinates (where possible) and related place metadata. |
title
and description
of the destination page.
Important Details:
entities
object of the Post payload - specifically in the entitites.urls.unwound
object. It provides the following fields of metadata:
unwound.url
unwound.status
unwound.title
unwound.description
Reason | Status Code Returned |
---|---|
SSL Exceptions | 403 (Forbidden) |
Unwinding not allowed by URL | 405 |
Socket Timeout | 408 (Timeout) |
Unknown Host Exception | 404 (Not Found) |
Unsupported Operation | 404 (Not Found) |
Connect Exception | 404 (Not Found) |
Illegal Argument | 400 (Bad Request) |
Everything else | 400 (Bad Request) |
matching_rules
object reflects all rules that matched the given result. In other words, if more than one rule matches a specific Post, it will only be delivered once, but the matching_rules
element will contain all the rules that matched.
Enriched native field name | Example value | Description |
---|---|---|
user.derived.locations.country | United States | The country location for where the user that created the Post is from. |
user.derived.locations.country_code | US | A two-letter ISO-3166 country code that corresponds to the country location for where the user that created the Post is from. |
user.derived.locations.locality | Birmingham | The locality location (generally city) for where the user that created the Post is from. |
user.derived.locations.region | Alabama | The region location (generally state/province) for where the user that created the Post is from. |
user.derived.locations.sub_region | Jefferson County | The sub-region location (generally county) for where the user that created the Post is from. |
user.derived.locations.full_name | Birmingham, Alabama, United States | The full name (excluding sub-region) for where the user that created the Post is from. |
User.derived.locations.geo | See Below | An array that includes a lat/long value for a coordinate that corresponds to the lowers granularity location for where the user that created the Post is from. |