Sprout Social

App · 16 actions

Read social profiles, analytics, messages, listening topics and cases, and create publishing posts.

Actions

ActionWhat it does
Create publishing postCreate publishing post.
Get post analyticsGet post analytics.
Get profile analyticsGet profile analytics.
Get publishing postGet publishing post.
Get topic metricsGet topic metrics.
List case queuesList case queues.
List casesList cases.
List customersList customers.
List groupsList groups.
List messagesList messages.
List profilesList profiles.
List tagsList tags.
List teamsList teams.
List topic messagesList topic messages.
List topicsList topics.
List usersList users.

Create publishing post

Create publishing post.

Inputs

Customercustomer_idtextRequired
Customer id.
Groupgroup_idnumberRequired
Group id.
Customer profile IDscustomer_profile_idslistRequired
Customer profile ids.
Is draftis_drafttrue/falseRequired
Is draft.
TexttexttextRequired
Text.
Deliverydeliveryobject
Additional structured delivery. Use the documented fields.
Mediamedialist
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

Customercustomer_idtextRequired
Customer id.
Filtersfilterslist
Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
Timezonetimezonetext
Timezone.
Pagepagenumber
Page.
Fieldsfieldslist
Fields.
Metricsmetricslist
Metrics.
Fromfrom_timedate and timeRequired
Start of the reporting range.
Untiluntil_timedate and timeRequired
End of the reporting range.
Profilesprofile_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

Customercustomer_idtextRequired
Customer id.
Filtersfilterslist
Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
Timezonetimezonetext
Timezone.
Pagepagenumber
Page.
Fieldsfieldslist
Fields.
Metricsmetricslist
Metrics.
Fromfrom_timedateRequired
Start of the reporting range.
Untiluntil_timedateRequired
End of the reporting range.
Profilesprofile_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

Customercustomer_idtextRequired
Customer id.
Publishing post IDpublishing_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

Customercustomer_idtextRequired
Customer id.
Topictopic_idtextRequired
Topic id.
Filtersfilterslist
Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
Timezonetimezonetext
Timezone.
Pagepagenumber
Page.
Fieldsfieldslist
Fields.
Metricsmetricslist
Metrics.
Dimensionsdimensionslist
Dimensions.
Fromfrom_timedate and timeRequired
Start of the reporting range.
Untiluntil_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

Customercustomer_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

Customercustomer_idtextRequired
Customer id.
Filtersfilterslist
Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
Timezonetimezonetext
Timezone.
Pagepagenumber
Page.
Sortsortlist
Sort.
Limitlimitnumber
Limit.
Page cursorpage_cursortext
Page cursor.
Fromfrom_timedate and timeRequired
Start of the reporting range.
Untiluntil_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

Customercustomer_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

Customercustomer_idtextRequired
Customer id.
Filtersfilterslist
Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
Timezonetimezonetext
Timezone.
Pagepagenumber
Page.
Fieldsfieldslist
Fields.
Sortsortlist
Sort.
Limitlimitnumber
Limit.
Page cursorpage_cursortext
Page cursor.
Fromfrom_timedate and timeRequired
Start of the reporting range.
Untiluntil_timedate and timeRequired
End of the reporting range.
Profilesprofile_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

Customercustomer_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

Customercustomer_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

Customercustomer_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

Customercustomer_idtextRequired
Customer id.
Topictopic_idtextRequired
Topic id.
Filtersfilterslist
Additional Sprout filter expressions. Date and profile filters can be selected using the other fields.
Timezonetimezonetext
Timezone.
Pagepagenumber
Page.
Fieldsfieldslist
Fields.
Metricsmetricslist
Metrics.
Sortsortlist
Sort.
Limitlimitnumber
Limit.
Page cursorpage_cursortext
Page cursor.
Fromfrom_timedate and timeRequired
Start of the reporting range.
Untiluntil_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

Customercustomer_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

Customercustomer_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
}

On this page