Last Updated: February 19, 2016
Fetching a full list of social posts by creation date
The API provides a way to fetch social posts and related comments by their creation date.
Request
HTTP Method | Resource URI |
---|---|
GET | https://{tenantName}.api.xomni.com/private/social/posts?createdOADate={createdOADate}&skip={skip}&take={take} |
URI Parameters
Parameter Name | Description | Type | Conditions |
---|---|---|---|
createdOADate | An OleAutomation Date defining a date without time precision. | Number | |
skip | The number of items in the collection to skip before executing a select. | Number | |
take | The number of items that should be fetched from the collection. | Number |
Request Headers
Header Field Name | Description |
---|---|
Accept |
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
|
Authorization |
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
|
Response
Response Body Description
Parameter Name | Description | Type |
---|---|---|
TotalCount | Total count of social posts. | Number |
Results[0..N].Author | The name of the PII User. | String |
Results[0..N].Id | The unique ID for the social XOMNI post. | Number |
Results[0..N].CreatedDate | The date when the post is created. | Date |
Results[0..N].Content | The text content of the message. | String |
Results[0..N].RelatedItemId | The integer ID of an item/product related to the social post. | Number |
Results[0..N].AvailablePlatforms[0..N].Platform | Name of the social platform. | String |
Results[0..N].AvailablePlatforms[0..N].Status | Status of the social interaction. | String |
Results[0..N].AvailablePlatforms[0..N].Author | Display name of the user in the social platform. | String |
Results[0..N].AvailablePlatforms[0..N].AuthorPictureUrl | Profile picture of the user in the social platform. | String |
Results[0..N].Comments[0..N].TargetPostId | The unique ID for the social XOMNI post which the current comment replies to and belongs to. | Number |
Results[0..N].Comments[0..N].TargetCommentId | The unique ID for the social XOMNI comment which the current comment replies to. | Number |
Results[0..N].Comments[0..N].Id | The unique ID for the social comment. | Number |
Results[0..N].Comments[0..N].CreatedDate | The date when the post is created. | Date |
Results[0..N].Comments[0..N].Content | The text content of the comment. | String |
Results[0..N].Comments[0..N].RelatedItemId | The integer ID of an item/product related to the social post. | Number |
Results[0..N].Comments[0..N].AvailablePlatforms[0..N].Platform | Name of the social platform. | String |
Results[0..N].Comments[0..N].AvailablePlatforms[0..N].Status | Status of the social interaction. | String |
Results[0..N].Comments[0..N].AvailablePlatforms[0..N].Author | Display name of the user in the social platform. | String |
Results[0..N].Comments[0..N].AvailablePlatforms[0..N].AuthorPictureUrl | Profile picture of the user in the social platform. | String |
Response Headers
Header Field Name | Description |
---|---|
Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
Status Codes
A successful operation returns status code 200 (OK) for GET operations. Possible response status codes are as listed below:
Status Code | Description |
---|---|
404 (Not Found) | Social post was not found. |