JSON reference for events from Social Engagement

This topic applies to version 2.1 of the JSON payload for social posts streamed to Microsoft Azure Event Hubs from Microsoft Social Engagement.

Latest version of the payload: Version 2.1

Note

New objects and properties can get added to the payload without increasing the version number.

For more information about getting a connection between Social Engagement and Azure Event Hubs up and running, see Stream data from Social Engagement to Microsoft Azure Event Hubs.

Overview

When Social Engagement streams events to Azure Event Hubs, a JSON payload is generated. A single social post in Social Engagement is a single event in the event hub. The JSON payload contains information about a single social post that matches the defined filters and action on the automation rules that generated the payload. Additional properties that you define in your automation rules are part of the metadata object. The main content is part of the post object.

metadata object elements

Use this table to get a quick link to metadata object properties.

JSON element Description
Metadata JSON payload objects JSON object describing the metadata for the payload sent to Azure Event Hubs.
metadata.matchedRules Array of automation rules that matched this post.
metadata.matchedRules.id ID of the automation rule that triggered the creation of this JSON payload.
metadata.matchedRules.name Name of the automation rule that triggered the creation of this JSON payload.
metadata.properties Array of key-value pairs defined in the additional properties of the "Stream to Event Hubs" action in an automation rule.
metadata.properties.key Key of a key-value pair provided in additional properties of an automation rule.
metadata.properties.value Value of a key-value pair provided in additional properties of an automation rule.
metadata.properties.matchedrule ID of the automation rule that contains the additional properties

Back to top

metadata sample payload

{  
  "metadata": {  
    "matchedRules": [  
      {  
        "id": 12345,  
        "name": "Support Requests"  
      },  
      {  
        "id": 54321,  
        "name": "Company News"  
      }  
    ],  
    "properties": [  
      {  
        "key": "customKey_1",  
        "value": "Some custom value.",  
        "matchedRule": 12345  
        },  

      {  
        "key": "customKey_2",  
        "value": "Some other custom value.",  
        "matchedRule": 54321  
      }  
    ]  
  }  

Back to top

post object elements

Use this table to get a quick link to post object properties.

JSON element Description
post.id The unique post ID in the Social Engagement solution database.
post.contentType The type of content in a post.
post.postType The type of the post in its conversational context.
post.uri The post's URI—a backlink to the post's original URI.
post.title The title as delivered from a post's meta information.
post.acquisitionDate Timestamp when the post was acquired in Social Engagement (in ISO 8601 format).
post.modificationDate Timestamp when the post was last updated in Social Engagement (in ISO 8601 format).
post.publicationDate Timestamp when the post was published on the source (in ISO 8601 format).
post.profile JSON object describing the social profile of the post's author.
post.source JSON object describing on which source a post was found.
post.content JSON object describing the content of a post.
post.language JSON object describing the language of a post.
post.abstractText Short excerpt of the post.
post.score JSON object describing the source specific score of the post or score of the author at the time the post was published.
post.referencedPost Information about the post that this post is a reply to, or a share of.
post.sentiment JSON object describing the sentiment of a post.
post.tags Array of JSON objects representing tags on a post that were added through Social Engagement.
post.externalId ID of the post on the source.
post.postLocation JSON object describing the location on which a post was published.
post.fullContentLength Length in characters of a post's text content.
post.origin JSON object describing the origin of a content. For example: Facebook page on which the post was published.
post.matchingSearchTopics Array of JSON objects describing the list of search topics a post matches.
post.externalCategories Array of categories as delivered by the data provider.
post.contributors Array of names of those who contributed to the post as provided by the data provider.
post.media Array of JSON objects describing the media in a post.
post.externalTopics Array of topics in this post as defined by the data provider.
post.contributorSummary Short description about the contributor for this post as delivered by external providers.

Back to top

post sample payload

Sample Twitter reply

This is a sample post payload for a Twitter reply acquired through Social Engagement. We've made up some values to anonymize the sample.

  "post": {  
    "id": "1234567",  
    "contentType": "POST",  
    "postType": "reply",  
    "uri": "http://twitter.com/externalHandle/status/1234567890",  
    "publicationDate": "2016-01-23T12:34:56.789+0000",  
    "acquisitionDate": "2016-01-23T12:34:56.789+0000",  
    "modificationDate": "2016-01-23T12:34:56.789+0000",  
    "profile": {  
      "name": "Display Name @chosenUserName",  
      "id": "41890771",  
      "profileIcon": "https://path/to/the/profileIcon.png",  
      "externalHandle": "chosenUserName",  
      "displayName": "Display Name",  
      "externalId": "7654321"  
    },  
    "source": {  
      "name": "Microblogs",  
      "id": "18",  
      "param": "Twitter"  
    },  
    "content": {  
      "text": "Main text content of the tweet."  
    },  
    "language": {  
      "name": "English",  
      "code": "en"  
    },  
    "abstractText": "Main text content of the tweet.",  
    "score": {  
      "normalScore": 3,  
      "providerScore": 29.0,  
      "provider": "KLOUT"  
    },  
    "referencedPost": {  
      "profile": {  
        "displayName": "Referenced Display Name",  
        "id": "987654321"  
      },  
      "externalId": "123456789",  
    },  
    "sentiment": {  
      "polarity": "negative",  
      "value": -0.46005836  
    },  
        "tags": [  
          {  
            "probability": 0.8339088,  
            "type": "system",  
            "tag": {  
              "name": "Information request",  
              "id": "2473",  
              "parentId": "2470"  
            }  
          }  
        ],  
    "externalId": "12345ab54321",  
    "fullContentLength": 137,  
    "matchingSearchTopics": [  
      {  
        "id": "1234567",  
        "name": "Contoso search topic",  
        "parentId": "7654321"  
      }  
    ],  
  }  
}  

Back to top

Sample Twitter retweet

This is a sample post payload for a Twitter retweet acquired through Social Engagement. We've made up some values to anonymize the sample.

  "post": {  
    "id": "5786261",  
    "contentType": "POST",  
    "postType": "share",  
    "uri": "http://twitter.com/externalHandle/statuses/1234567890",  
    "publicationDate": "2016-01-23T12:34:56-07:00",  
    "acquisitionDate": "2016-01-23T12:34:56-07:00",  
    "modificationDate": "2016-01-23T12:34:56-07:00",  
    "profile": {  
      "name": "Display Name @chosenUserName",  
      "id": "3464522345",  
      "profileIcon": "https://path/to/the/profileIcon.png",  
      "externalHandle": "chosenUserName",  
      "displayName": "Display Name",  
      "externalId": "7654321"  
    },  
    "source": {  
      "name": "Microblogs",  
      "id": "18",  
      "param": "Twitter"  
    },  
    "content": {  
      "text": "Main text of the tweet."  
    },  
    "language": {  
      "name": "English",  
      "code": "en"  
    },  
    "abstractText": "Main text of the tweet.",  
    "score": {  
      "normalScore": 4,  
      "providerScore": 46.0,  
      "provider": "KLOUT"  
    },  
    "referencedPost": {  
      "profile": {  
        "name": "Display Name of retweeted profile @anotherChosenUserName",  
        "profileIcon": "https://path/to/the/profileIcon.png",  
        "externalHandle": "anotherChosenUserName",  
        "displayName": "Display Name of retweeted profile"  
      },  
      "externalId": "123456789"  
    },  
    "sentiment": {  
      "polarity": "negative",  
      "value": -0.6864638  
    },  
    "tags": [  
      {  
        "probability": 0.8339088,  
        "type": "system",  
        "tag": {  
          "name": "Information request",  
          "id": "2473",  
          "parentId": "2470"  
        }  
      }  
    ],  
    "externalId": "12345ab54321",  
    "fullContentLength": 139,  
    "matchingSearchTopics": [  
      {  
        "name": "Contoso search topic",  
        "id": "12345",  
        "parentId": "54321"  
      }  
    ]  
  }  
}  

Back to top

Sample Facebook reply

This is a sample post payload for a Facebook reply acquired through Social Engagement. We've made up some values to anonymize the sample.

  "post": {  
    "id": "1234567",  
    "contentType": "POST",  
    "postType": "reply",  
    "uri": "http://www.facebook.com/123456789/posts/987654321?comment_id=123123123",  
    "publicationDate": "2016-01-23T12:34:56-07:00",  
    "acquisitionDate": "2016-01-23T12:34:56-07:00",  
    "modificationDate": "2016-01-23T12:34:56-07:00",  
    "profile": {  
      "name": "Name of the profile",  
      "id": "43214321",  
      "profileIcon": "http://graph.facebook.com/123456789/picture?type=square",  
      "externalId": "123456789"  
    },  
    "source": {  
      "name": "Facebook Posts",  
      "id": "16",  
      "param": "Facebook"  
    },  
    "content": {  
      "text": "Text as provided for the reply. This is usually a text that contains several sentences. This example highlights the difference between post.content and post.abstractText."  
    },  
    "language": {  
      "name": "English",  
      "code": "en"  
    },  
    "abstractText": "Text as provided for the reply. This is usually a",  
    "referencedPost": {  
      "externalId": "987654321"  
    },  
    "sentiment": {  
      "polarity": "neutral",  
      "value": -0.0023945  
    },  
    "externalId": "321321321",  
    "fullContentLength": 227,  
    "origin": {  
      "id": "12345",  
      "externalId": "123456789"  
    },  
    "matchingSearchTopics": [  
      {  
        "name": "Contoso search topic",  
        "id": "12345",  
        "parentId": "54321"  
      }  
    ]  
  }  
}  

Back to top

Sample video post

This is a sample post payload for a video post acquired through Social Engagement. We've made up some values to anonymize the sample.

  "post": {  
    "id": "1234567",  
    "contentType": "VIDEO",  
    "postType": "post",  
    "uri": "http://www.youtube.com/watch?v=videoId",  
    "title": "Title of the video",  
    "publicationDate": "2016-01-23T12:34:56-07:00",  
    "acquisitionDate": "2016-01-23T12:34:56-07:00",  
    "modificationDate": "2016-01-23T12:34:56-07:00",  
    "profile": {  
      "name": "Name of the profile",  
      "id": "1234567",  
      "externalId": "98765abc4321"  
    },  
    "source": {  
      "name": "Youtube Videos",  
      "id": "19",  
      "param": "YoutubeVideos"  
    },  
    "content": {  
      "text": "Text description as provided for the video. This is usually a text that contains several sentences. This example highlights the difference between post.content and post.abstractText."  
    },  
    "language": {  
      "name": "English",  
      "code": "en"  
    },  
    "abstractText": "Text description as provided for the video. This is usually a",  
    "embeddedMedia": "http://www.youtube.com/embed/videoId",  
    "media": [  
      {  
        "type": "VIDEO",  
        "embedUrl": "http://www.youtube.com/embed/videoId"  
      }  
    ],  
    "sentiment": {  
      "polarity": "neutral",  
      "value": -0.07142752  
    },  
    "fullContentLength": 358,  
    "matchingSearchTopics": [  
      {  
        "name": "Contoso search topic",  
        "id": "12345",  
        "parentId": "54321"  
      }  
    ]  
  }  
}  

Back to top

Sample blog post

This is a sample post payload for a blog post acquired through Social Engagement. We've made up some values to anonymize the sample.

  "post": {  
    "id": "1234567",  
    "contentType": "POST",  
    "postType": "post",  
    "uri": "http://someblog.tld/path/to/post",  
    "title": "Heading of this blog",  
    "acquisitionDate": "2016-01-23T12:34:56.789+0000",  
    "modificationDate": "2016-01-23T12:34:56.789+0000",  
    "publicationDate": "2016-01-23T12:34:56.789+0000",  
    "profile": {  
      "name": "Name of the profile",  
      "id": "1234567",  
      "externalId": "987654321"  
    },  
    "source": {  
      "name": "Blogs",  
      "id": "14",  
      "param": "Blogs"  
    },  
    "content": {  
      "text": "Main text content of the blog post. This is usually a text that contains several sentences. This example highlights the difference between post.content.text and post.abstractText."  
    },  
    "language": {  
      "name": "English",  
      "code": "en"  
    },  
    "abstractText": "Main text content of the blog post. This is usually a text that",  
    "sentiment": {  
      "polarity": "positive",  
      "value": 0.3150851  
    },  
    "externalId":"123456789abcd987654321",  
    "fullContentLength": 119,  
    "matchingSearchTopics": [  
      {  
        "id": "1234567",  
        "name": "Contoso search topic",  
        "parentId": "7654321"  
      }  
    ]  
  }  
}  

Back to top

Sample forum post

This is a sample post payload for a forum post acquired through Social Engagement. We've made up some values to anonymize the sample.

  "post": {  
    "id": "1234567",  
    "contentType": "POST",  
    "postType": "reply",  
    "uri": "http://forumdomain.tld/path/to/the/forum",  
    "publicationDate": "2016-01-23T12:34:56.789+0000",  
    "acquisitionDate": "2016-01-23T12:34:56.789+0000",  
    "modificationDate": "2016-01-23T12:34:56.789+0000",  
    "profile": {  
      "name": "Name of the profile",  
      "id": "1234567",  
      "displayName": "Name of the profile",  
      "externalHandle": "Name of the profile",  
      "externalId": "987654321"  
    },  
    "source": {  
      "name": "Board",  
      "id": "15",  
      "param": "Board"  
    },  
    "content": {  
      "text": "Main text content of the forum post."  
    },  
    "language": {  
      "name": "English",  
      "code": "en"  
    },  
    "abstractText": "Abstract text of the forum post.",  
    "referencedPost": {  
      "externalId":"123456789abcd987654321",  
    },  
    "sentiment": {  
      "polarity": "positive",  
      "value": 0.3773585  
    },  
    "externalId":"123456789abcd987654321",  
    "fullContentLength": 398,  
    "origin": {  
      "externalId":"123ab321",  
      "name":"Title of the forum",  
    },  
    "matchingSearchTopics": [  
      {  
        "id": "1234567",  
        "name": "Contoso search topic",  
        "parentId": "7654321"  
      }  
    ],  
  }  
}  

Back to top

Metadata JSON payload objects

Read up on the fields currently supported in the metadata JSON payload.

metadata.matchedRules

Array describing the automation rules that match this post.

Property Value Type: object

Parent: metadata

Sample: metadata sample payload

Back to top

metadata.matchedRules.id

ID of the automation rule that triggered the creation of this JSON payload.

Property Value Type: number (integer)

Parent: metadata.matchedRules

Sample: metadata sample payload

metadata.matchedRules.name

Name of the automation rule that triggered the creation of this JSON payload.

Property Value Type: string

Parent: metadata.matchedRules

Sample: metadata sample payload

metadata.properties

Array of key-value pairs defined in the additional properties of the "Stream to Event Hubs" action in an automation rule.

Property Value Type: object

Parent: metadata

Sample: metadata sample payload

Back to top

metadata.properties.key

Key of a key-value pair provided in additional properties of an automation rule.

Property Value Type: number (integer)

Parent: metadata.properties

Sample: metadata sample payload

metadata.properties.value

Value of a key-value pair provided in additional properties of an automation rule.

Property Value Type: string

Parent: metadata.properties

Sample: metadata sample payload

metadata.properties.matchedrule

ID of the automation rule that contains the additional properties.

Property Value Type: string

Parent: metadata.properties

Sample: metadata sample payload

Post JSON payload objects

Read up on the fields currently supported in the post JSON payload.

post.id

The unique post ID in the Social Engagement solution database.

Property Value Type: number (integer)

Parent: post

Sample: post sample payload

Back to top

post.contentType

The type of content in a post.

Property Value Type: enum

Property Values:

  • POST: The main content is text.

  • IMAGE: The main content is a picture.

  • VIDEO: The main content is a video.

  • LINK: The main content is a hyperlink.

    Parent: post

    Sample: post sample payload

    Back to top

post.postType

The type of post in its conversational context.

Property Value Type: enum

Property Values:

  • post: An original post, that other posts are related to. Think of the start of a conversation.

  • reply: A reply or a comment to an original post.

  • share: A share or retweet of an original post.

  • privatemessage: A private conversation between two (or more) profiles.

    Parent: post

    Sample: post sample payload

    Back to top

post.uri

A backlink to the post's original URI.

Note

The URI of news posts can't be used to link back to the original article.

Property Value Type: string

Parent: post

Sample: post sample payload

Back to top

post.title

The title as delivered from a post's meta information.

Note

Not all posts have a title.

Property Value Type: string

Parent: post

Sample: post sample payload

Back to top

post.acquisitionDate

Timestamp when the post was acquired in Social Engagement (in ISO 8601 format).

Property Value Type: date-time

Parent: post

Sample: post sample payload

Back to top

post.modificationDate

Timestamp when the post was last updated in Social Engagement (in ISO 8601 format).

Property Value Type: date-time

Parent: post

Sample: post sample payload

Back to top

post.publicationDate

Timestamp when the post was published on the source (in ISO 8601 format).

Property Value Type: date-time

Parent: post

Sample: post sample payload

Back to top

post.profile

JSON object describing the social profile of the post's author.

In the Social Engagement user interface, this is referred to as an "author". More information: Find out what people are talking about, See author details

Property Value Type: object

JSON element Description
post.profile.id Unique ID of the profile in the Social Engagement solution database.
post.profile.profileIcon URI to public profile picture.
post.profile.profileLocation JSON object describing the author's location information as specified by the author.
post.profile.externalHandle Alias or handle of a profile.
post.profile.displayName Display name of a profile as provided on the source.
post.profile.externalId ID of the profile on the source.
post.profile.name Name for the profile in the Social Engagement user interface.

Parent: post

Sample:

"profile": {  
  "name": "Display Name @externalHandle",  
  "id": "41890771",  
  "profileIcon": "https://path/to/the/profileIcon.png" ,  
  "profileLocation": {  
    "locality": "Boston",  
    "adminDistrict": "Massachusetts",  
    "countryRegion": "United States",  
    "coordinates": {  
      "latitude": 42.156028747558594,  
      "longitude": -71.56590270996094  
    },  
    "quadKey": "030233212221101333012"  
  },  
  "displayName": "Display Name ",  
  "externalId": "1234567"  
  },  

Back to top

post.profile.id

Unique ID of the profile in the Social Engagement solution database.

Property Value Type: string

Parent: post.profile

Sample: post.profile

post.profile.profileIcon

URI to public profile picture.

Property Value Type: string

Parent: post.profile

Sample: post.profile

post.profile.profileLocation

JSON object describing the author's location information as specified by the author.

For some sources, profile owners can provide their location information. This is shown in the user interface as author location, as opposed to the post location, which specifies from where the post was published. For the post location, see post.postLocation

Property Value Type: object

JSON element Description
post.profile.profileLocation.locality Represents the name of a city.
post.profile.profileLocation.adminDistrict Represents the name of an administrative division, for example a federal state or a province.
post.profile.profileLocation.countryRegion Represents the name of a country or region.
post.profile.profileLocation.coordinates JSON object describing the coordinates of a social profile with latitude and longitude.
post.profile.profileLocation.coordinates.latitude Geographic latitude.
post.profile.profileLocation.coordinates.longitude Geographic longitude.
post.profile.profileLocation.quadkey Quadtree key of a location, or “quadkey” for short. Identifies a single tile at a particular level of detail on a map.

Parent: post.profile

Sample:

"profileLocation": {  
  "locality": "Boston",  
  "adminDistrict": "Massachusetts",  
  "countryRegion": "United States",  
  "coordinates": {  
    "latitude": 42.156028747558594,  
    "longitude": -71.56590270996094  
  },  
  "quadKey": "030233212221101333012"  
},  

post.profile.profileLocation.locality

Represents the name of a city.

Property Value Type: string

Parent: post.profile

Sample: post.profile.profileLocation

post.profile.profileLocation.adminDistrict

Represents the name of an administrative division, for example a federal state or a province.

Property Value Type: string

Parent: post.profile

Sample: post.profile.profileLocation

post.profile.profileLocation.countryRegion

Represents the name of a country or region.

Property Value Type: string

Parent: post.profile

Sample: post.profile.profileLocation

post.profile.profileLocation.coordinates

JSON object describing the coordinates of a social profile with latitude and longitude.

Sample:

"coordinates": {  
  "latitude": 42.156028747558594,  
  "longitude": -71.56590270996094  
},  

post.profile.profileLocation.coordinates.latitude

Geographic latitude.

Property Value Type: number (floating point)

Parent: post.profile.profileLocation.coordinates

Sample: post.profile.profileLocation.coordinates

post.profile.profileLocation.coordinates.longitude

Geographic longitude.

Property Value Type: number (floating point)

Parent: post.profile.profileLocation.coordinates

Sample: post.profile.profileLocation.coordinates

post.profile.profileLocation.quadkey

Quadtree key of a location, or “quadkey” for short. Identifies a single tile at a particular level of detail on a map. More information: MSDN: Bing Maps Tile System

Property Value Type: string

Parent: post.profile.profileLocation

Sample: post.profile.profileLocation

post.profile.externalHandle

Alias or handle of a profile.

Property Value Type: string

Parent: post.profile

Sample: post.profile

post.profile.displayName

Display name of a profile as provided on the source.

Property Value Type: string

Parent: post.profile

Sample: post.profile

post.profile.externalId

ID of the profile on the source.

Property Value Type: string

Parent: post.profile

Sample: post.profile

post.profile.name

Representation in Social Engagement for the name for the profile.

Property Value Type: string

Parent: post.profile

Sample: post.profile

post.source

JSON object describing on which source a post was found.

Sample:

"source": {  
  "name": "Microblogs",  
  "id": "18",  
  "param": "Twitter"  
}  

Back to top

post.source.id

Represents the internal ID of the source that a post was found on.

Property Value Type: string

Parent: post.source

Sample: post.source

Back to top

post.source.name

Represents the name of the source that a post was found on.

Property Value Type: string

Parent: post.source

Sample: post.source

Back to top

post.source.param

Describes on which source a post was found.

Property Value Type: enum

The sources availablility extends over time. For an up-to-date list, check back often and follow the release announcements.

Parent: post.source

Sample: post.source

Back to top

post.content

JSON object describing the text content of a post.

Property Value Type: object

Parent: post

Sample:

{  
    “post” {  
        "content": {  
            "text": "Lorem ispum dolor sit amet...",  
            "metaText": "Lorem, dolor, amet",  
        }  
    }  
}  

Back to top

post.content.text

Text content of the post.

Property Value Type: string

Parent: post.content

Sample: post.content

post.content.metaText

Meta text of the post.

Property Value Type: string

Parent: post.content

Sample: post.content

post.language

JSON object describing the language of a post.

Property Value Type: object

JSON element Description
post.language.name The localized language name in the locale chosen in Global Settings.
post.language.code Language code (in ISO 639-1 format) for the post.

Parent: post

Sample:

{  
    “post” {  
        "language": {  
            "name": "Finnish",  
            "code": "fi",  
        }  
    }  
}  

Back to top

post.language.name

The localized language name in the locale chosen in Global Settings.

Property Value Type: string

Parent: post.language

Sample: post.language

post.language.code

Language code (in ISO 639-1 format) for the post.

Property Value Type: string

Parent: post.language

Sample: post.language

post.abstractText

Short excerpt of the post.

Property Value Type: string

Parent: post

Sample: post sample payload

Back to top

post.score

JSON object describing the source-specific score of the post or score of the author at the time the post was published.

Property Value Type: object

Parent: post

Sample:

"score": {  
  "normalScore": 3,  
  "providerScore": 29.0,  
  "provider": "KLOUT"  
}  

Back to top

post.score.normalScore

Normalized score, from 1 (lowest) to 5 (highest).

Property Value Type: number (integer)

Parent: post.score

Sample: post.score

post.score.providerScore

Non-normalized score as given by the score provider.

Property Value Type: number (floating point)

Parent: post.score

Sample: post.score

post.score.provider

Scoring service the score is provided from.

Parent: post.score

Sample: post.score

post.referencedPost

Information about the post that this post is a reply to, or a share of. referencedPost has the same structure as the parent post, although only a subset of its fields contain data.

Property Value Type: object

Parent: post

Sample:

{  
    “post” {  
        "referencedPost": {  
            "id": "123456789",  
            "externalId": "654321",  
            "profile": {  
                "id": "123456",  
                "name": "Microsoft"  
            }  
        }  
    }  
}  

Back to top

post.sentiment

JSON object describing the sentiment of a post.

Property Value Type: object

Parent: post

Sample:

"sentiment": {  
  "polarity": "negative",  
  "value": -0.46005836  
}  

Back to top

post.sentiment.polarity

Sentiment value of a post. More information: Adaptive learning based on changes to organization’s sentiment values, Understand the public perception using sentiment analysis

Property Value Type: enum

Property Values:

  • Positive: Post has a positive sentiment value.

  • Negative: Post has a negative sentiment value.

  • Neutral: Post has neither a positive nor a negative sentiment value.

    Parent: post.sentiment

    Sample: post.sentiment

post.sentiment.value

Sentiment value as a decimal value between -1 and 1.

Property Value Type: number

Parent: post.sentiment

Sample: post.sentiment

post.tags

Array of JSON objects representing tags on a post that were added through Social Engagement.

Property Value Type: object

JSON element Description
post.tags.probability Probability provided by the machine learning model with which a system tag applies to a post.
post.tags.type Describes how the tag was assigned to a post.
post.tags.tag JSON object describing the tag.
post.tags.tag.id Internal ID of the tag.
post.tags.tag.name Name of the tag. Intention tags are localized in the locale chosen in Global Settings.
post.tags.tag.parentId ID of the group containing the tag.

Parent: post

Sample:

"tags": [ {  
  "probability": 0.7554345,  
  "type": "system",  
  "tag": {  
    "id": "12345",  
    "name": "Support request",  
    "parentId": "54321"  
  }, {...} ]  

Back to top

post.tags.probability

Probability provided by the machine learning model with which a system tag applies to a post.

Property Value Type: number

Parent: post.tags

Sample: post.tags

post.tags.type

Describes how the tag was assigned to a post.

Note

Since automation rules pick up the posts before users can manually confirm or add tags to posts, this property usually has the value "system".

Property Value Type: enum

Property Values:

  • system: Social Engagement added the tag to the post.

  • user: A user manually added the tag to the post.

  • confirmed: A user confirmed a tag that was added by Social Engagement.

    Parent: post.tags

    Sample: post.tags

post.tags.tag

JSON object describing the tag.

Property Value Type: object

Parent: post.tags

Sample:

"tag": {  
  "id": "12345",  
  "name": "Support request",  
  "parentId": "54321"  
},  

post.tags.tag.id

Internal ID of the tag.

Property Value Type: string

Parent: post.tags.tag

Sample: post.tags.tag

post.tags.tag.name

Name of the tag. Intention tags are localized in the locale chosen in Global Settings. More information: Understand an author's intent using intention analysis

Property Value Type: string

Parent: post.tags.tag

Sample: post.tags.tag

post.tags.tag.parentId

ID of the group containing the tag.

Property Value Type: string

Parent: post.tags.tag

Sample: post.tags.tag

post.externalId

ID of the post on the source.

Property Value Type: string

Parent: post

Sample: post sample payload

Back to top

post.postLocation

JSON object describing the location from which a post was published.

Property Value Type: object

JSON element Description
post.postLocation.locality Represents the name of a city.
post.postLocation.adminDistrict Represents the name of an administrative division, for example a federal state or a province.
post.postLocation.countryRegion Represents the name of a country or region.
post.postLocation.coordinates JSON object describing the coordinates of a post as defined by the author with latitude and longitude.
post.postLocation.coordinates.latitude Geographic latitude.
post.postLocation.coordinates.longitude Geographic longitude.
post.postLocation.quadkey Quadtree key of a location, or “quadkey” for short. Identifies a single tile at a particular level of detail on a map.

Parent: post

Sample:

"postLocation": {  
  "adminDistrict": "Massachusetts",  
  "countryRegion": "United States",  
  "coordinates": {  
    "latitude": 42.156028747558594,  
    "longitude": -71.56590270996094  
  },  
  "quadKey": "030233212221101333012"  
},  

Back to top

post.postLocation.locality

Represents the name of a city.

Property Value Type: string

Parent: post.postLocation

Sample: post.postLocation

post.postLocation.adminDistrict

Represents the name of an administrative division, for example a federal state or a province.

Property Value Type: string

Parent: post.postLocation

Sample: post.postLocation

post.postLocation.countryRegion

Represents the name of a country or region.

Property Value Type: string

Parent: post.postLocation

Sample: post.postLocation

post.postLocation.coordinates

JSON object describing the coordinates of a post as defined by the author with latitude and longitude.

Property Value Type: object

Parent: post.postLocation

Sample:

"coordinates": {  
  "latitude": 42.156028747558594,  
  "longitude": -71.56590270996094  
},  

post.postLocation.coordinates.latitude

Geographic latitude.

Property Value Type: number (floating point)

Parent: post.profile.profileLocation.coordinates

Sample: post.postLocation.coordinates

post.postLocation.coordinates.longitude

Geographic longitude.

Property Value Type: number (floating point)

Parent: post.postLocation.coordinates

Sample: post.postLocation.coordinates

post.postLocation.quadkey

Quadtree key of a location, or “quadkey” for short. Identifies a single tile at a particular level of detail on a map. More information: MSDN: Bing Maps Tile System

Property Value Type: string

Parent: post.postLocation

Sample: post.postLocation

Back to top

post.fullContentLength

Length in characters of the text-only content in a post.

Property Value Type: number (integer)

Parent: post

Sample: post sample payload

Back to top

post.origin

JSON object describing the origin of the post on the source. This is different from the post.source object. For example: A specific Facebook page on the Facebook source.

Property Value Type: object

Parent: post

Sample:

"origin": {  
  "id": "12345",  
  "externalId": "54321",  
  "name": "Microsoft Facebook Page",  
},  

Back to top

post.origin.id

ID of the internal representation in Social Engagement for the origin of a post.

Property Value Type: string

Parent: post.origin

Sample: post.origin

post.origin.externalId

ID of the origin for the original source of a post.

Property Value Type: string

Parent: post.origin

Sample: post.origin

post.origin.name

Name of the origin of the post on the source.

Property Value Type: string

Parent: post.origin

Sample: post.origin

post.matchingSearchTopics

Array of JSON objects describing the list of search topics a post matches.

Property Value Type: object

Parent: post

Sample:

        "matchingSearchTopics": [{  
          "name": "Contoso Brand Mentions",  
          "id": "12345",  
          "parentId": "54321",  
        },  
{...}]  

Back to top

post.matchingSearchTopics.name

Name of the search topic as defined in Social Engagement. More information: Set up searches to listen to social media conversations

Property Value Type: string

Parent: post.matchingSearchTopics

Sample: post.matchingSearchTopics

post.matchingSearchTopics.id

ID of the search topic.

Property Value Type: string

Parent: post.matchingSearchTopics

Sample: post.matchingSearchTopics

post.matchingSearchTopics.parentId

ID of the search topics's category.

Property Value Type: string

Parent: post.matchingSearchTopics

Sample: post.matchingSearchTopics

post.externalCategories

Array of categories as delivered by external providers.

Note

This property is only available for News posts.

Property Value Type: array of strings

Parent: post

Sample: post sample payload

Back to top

post.contributors

Array of names of those who contributed to the post as provided by the data provider.

Note

This property is only available for News posts.

Property Value Type: array of strings

Parent: post

Sample: post sample payload

Back to top

post.media

Array of JSON objects describing the media in a post.

Property Value Type: objects

JSON element Description
post.media.type The type of media content.
post.media.embedUrl URL embedding the media file.

Parent: post

Sample:

"media": {  
  "type": "VIDEO",  
  "embedUrl": "http://www.youtube.com/embed/1dWKf8d8zfg"  
},  

Back to top

post.media.type

The type of media content.

Property Value Type: enum

Property Values:

  • POST: The main media content is text.

  • IMAGE: The main media content is a picture.

  • VIDEO: The main media content is a video.

  • LINK: The main media content is a hyperlink.

    Parent: post.media

    Sample: post.media

post.media.embedUrl

URL embedding the media file.

Property Value Type: string

Parent: post.media

Sample: post.media

post.externalTopics

Array of topics in this post as delivered by external providers.

Property Value Type: array of strings

Parent: post

Sample: post sample payload

Back to top

post.contributorSummary

Short description about the contributor for this post as delivered by external providers.

Property Value Type: string

Parent: post

Sample: post sample payload

Back to top

See Also

Manage connections in Social Engagement
Stream data from Social Engagement to Microsoft Azure Event Hubs
Work with events from social posts in Azure Event Hubs