Sprout Social
App · 16 actions
Read social profiles, analytics, messages, listening topics and cases, and create publishing posts.
Actions
| Action | What it does |
|---|---|
| Create publishing post | Create publishing post. |
| Get post analytics | Get post analytics. |
| Get profile analytics | Get profile analytics. |
| Get publishing post | Get publishing post. |
| Get topic metrics | Get topic metrics. |
| List case queues | List case queues. |
| List cases | List cases. |
| List customers | List customers. |
| List groups | List groups. |
| List messages | List messages. |
| List profiles | List profiles. |
| List tags | List tags. |
| List teams | List teams. |
| List topic messages | List topic messages. |
| List topics | List topics. |
| List users | List users. |
Create publishing post
Create publishing post.
Inputs
- Customer
customer_idtextRequired - Customer id.
- Group
group_idnumberRequired - Group id.
- Customer profile IDs
customer_profile_idslistRequired - Customer profile ids.
- Is draft
is_drafttrue/falseRequired - Is draft.
- Text
texttextRequired - Text.
- Delivery
deliveryobject - Additional structured delivery. Use the documented fields.
- Media
medialist - Media.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}Get post analytics
Get post analytics. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
- Filters
filterslist - Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
- Timezone
timezonetext - Timezone.
- Page
pagenumber - Page.
- Fields
fieldslist - Fields.
- Metrics
metricslist - Metrics.
- From
from_timedate and timeRequired - Start of the reporting range.
- Until
until_timedate and timeRequired - End of the reporting range.
- Profiles
profile_idslistRequired - Social profiles to include.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}Get profile analytics
Get profile analytics. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
- Filters
filterslist - Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
- Timezone
timezonetext - Timezone.
- Page
pagenumber - Page.
- Fields
fieldslist - Fields.
- Metrics
metricslist - Metrics.
- From
from_timedateRequired - Start of the reporting range.
- Until
until_timedateRequired - End of the reporting range.
- Profiles
profile_idslistRequired - Social profiles to include.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}Get publishing post
Get publishing post. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
- Publishing post ID
publishing_post_idtextRequired - Publishing post id.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}Get topic metrics
Get topic metrics. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
- Topic
topic_idtextRequired - Topic id.
- Filters
filterslist - Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
- Timezone
timezonetext - Timezone.
- Page
pagenumber - Page.
- Fields
fieldslist - Fields.
- Metrics
metricslist - Metrics.
- Dimensions
dimensionslist - Dimensions.
- From
from_timedate and timeRequired - Start of the reporting range.
- Until
until_timedate and timeRequired - End of the reporting range.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List case queues
List case queues. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List cases
List cases. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
- Filters
filterslist - Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
- Timezone
timezonetext - Timezone.
- Page
pagenumber - Page.
- Sort
sortlist - Sort.
- Limit
limitnumber - Limit.
- Page cursor
page_cursortext - Page cursor.
- From
from_timedate and timeRequired - Start of the reporting range.
- Until
until_timedate and timeRequired - End of the reporting range.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List customers
List customers. Returns the full service response for the connected account.
Inputs
None.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List groups
List groups. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List messages
List messages. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
- Filters
filterslist - Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
- Timezone
timezonetext - Timezone.
- Page
pagenumber - Page.
- Fields
fieldslist - Fields.
- Sort
sortlist - Sort.
- Limit
limitnumber - Limit.
- Page cursor
page_cursortext - Page cursor.
- From
from_timedate and timeRequired - Start of the reporting range.
- Until
until_timedate and timeRequired - End of the reporting range.
- Profiles
profile_idslist - Social profiles to include.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List profiles
List profiles. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List tags
List tags. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List teams
List teams. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List topic messages
List topic messages. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
- Topic
topic_idtextRequired - Topic id.
- Filters
filterslist - Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
- Timezone
timezonetext - Timezone.
- Page
pagenumber - Page.
- Fields
fieldslist - Fields.
- Metrics
metricslist - Metrics.
- Sort
sortlist - Sort.
- Limit
limitnumber - Limit.
- Page cursor
page_cursortext - Page cursor.
- From
from_timedate and timeRequired - Start of the reporting range.
- Until
until_timedate and timeRequired - End of the reporting range.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List topics
List topics. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List users
List users. Returns the full service response for the connected account.
Inputs
- Customer
customer_idtextRequired - Customer id.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}