POST GET socialMessages/search
Search social messages by various criteria
* required
Parameters
Name | Type | Description |
---|---|---|
status | array[string] |
Search social messages by one or more delivery statuses
Draft, Sent, Scheduled, In Progress
|
campaignID | integer | Search social messages by campaign |
linkedAccountID | integer | Search social messages by linked account |
dateSentStart | datetime | Search social messages sent on or after this date |
dateSentEnd | datetime | Search social messages sent on or before this date |
page | integer |
Number of page in results to return
1
1
|
rpp | integer |
Number of records to return per page
20
1
250
|
sortField | string |
The field to sort results by
dateAdded
messageID, dateAdded, dateModified, dateSent
|
sortDirection | string |
The direction to sort results
desc
asc, desc
|
Response Data
Name | Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
content | object |
|
|||||||||||||||||||||||||||
dateAdded | datetime | Date the social message was added | |||||||||||||||||||||||||||
dateModified | datetime | Date the social message was modified | |||||||||||||||||||||||||||
dateScheduled | datetime | Date the social message was scheduled to be sent | |||||||||||||||||||||||||||
dateSent | datetime | Date the social message was sent | |||||||||||||||||||||||||||
external | boolean | When true, indicates that the social message did not originate from its linked account in the emfluence Marketing Platform | |||||||||||||||||||||||||||
externalMessageID | string | ID of social message in its respective social channel | |||||||||||||||||||||||||||
linkedAccountID | integer | ID of the linked account the social message belongs to | |||||||||||||||||||||||||||
messageID | integer | Unique ID of the social message | |||||||||||||||||||||||||||
metrics | object |
Metrics are only available for social messages with a status of "Sent". Some metrics are channel-specific. Note that metrics data may be delayed.
|
|||||||||||||||||||||||||||
permalink | string | URL to the social message in its respective social channel's web application | |||||||||||||||||||||||||||
source | string | Application the social message originated from | |||||||||||||||||||||||||||
status | string | Delivery status of the social message. One of: Draft, Sent, Scheduled, In Progress | |||||||||||||||||||||||||||
title | string | Used for display purposes only | |||||||||||||||||||||||||||
userID | integer | ID of system user the social message belongs to |
API Console
The console uses production data, so BE CAREFUL!
GET
socialMessages/search