Agorapulse
App · 20 actions
Read Agorapulse reports, inbox and listening data; discover workspaces and profiles; watch inbox items, notes and listening results.
Actions
| Action | What it does |
|---|---|
| Compute metric set | Compute metric set. |
| Get audience report | Get audience report. |
| Get community report | Get community report. |
| Get competitor report | Get competitor report. |
| Get content report | Get content report. |
| Get inbox item | Get inbox item. |
| Get search engagement | Get search engagement. |
| Get search keywords | Get search keywords. |
| Get search sentiment | Get search sentiment. |
| Get search volume | Get search volume. |
| List competitors | List competitors. |
| List inbox items | List inbox items. |
| List listening items | List listening items. |
| List menu groups | List menu groups. |
| List metric sets | List metric sets. |
| List notes | List notes. |
| List organizations | List organizations. |
| List profiles | List profiles. |
| List searches | List searches. |
| List workspaces | List workspaces. |
Compute metric set
Compute metric set.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- Account uids
account_uidslistRequired - Profiles (account uids) to compute the metric set for
- Metric set
metric_settextRequired - Metric set identifier returned by discovery
- Options
optionsobject - Option values keyed by option name, as advertised in discovery
- Since
sincedate and time - Start date (inclusive) in YYYY-MM-DD format, e.g. 2025-06-01; defaults to 30 days ago. The range must be at most 1 year and cannot be in the future.
- Until
untildate and time - End date (inclusive) in YYYY-MM-DD format, e.g. 2025-06-30; defaults to today
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Get audience report
Get audience report.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- Profile uid
profile_uidtextRequired - Profile uid
- Since
sincedate and timeRequired - Start of the period, inclusive: a Unix timestamp in seconds (1767225600), an ISO 8601 date (2026-01-01) or an ISO 8601 date-time with offset (2026-01-01T00:00:00Z). The period is resolved to whole days in the profile time zone; an ISO 8601 date is taken as is. Must not be in the future, and until must be at most 365 days after since.
- Until
untildate and timeRequired - End of the period, inclusive: a Unix timestamp in seconds (1767225600), an ISO 8601 date (2026-01-01) or an ISO 8601 date-time with offset (2026-01-01T00:00:00Z). The period is resolved to whole days in the profile time zone; an ISO 8601 date is taken as is. Must not be in the future, and until must be at most 365 days after since.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}Get community report
Get community report.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- Profile uid
profile_uidtextRequired - Profile uid
- Since
sincedate and timeRequired - Start of the period, inclusive: a Unix timestamp in seconds (1767225600), an ISO 8601 date (2026-01-01) or an ISO 8601 date-time with offset (2026-01-01T00:00:00Z). The period is resolved to whole days in the profile time zone; an ISO 8601 date is taken as is. Must not be in the future, and until must be at most 365 days after since.
- Until
untildate and timeRequired - End of the period, inclusive: a Unix timestamp in seconds (1767225600), an ISO 8601 date (2026-01-01) or an ISO 8601 date-time with offset (2026-01-01T00:00:00Z). The period is resolved to whole days in the profile time zone; an ISO 8601 date is taken as is. Must not be in the future, and until must be at most 365 days after since.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}Get competitor report
Get competitor report.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- Profile uid
profile_uidtextRequired - Profile uid
- Since
sincedate and timeRequired - Start of the period, inclusive: a Unix timestamp in seconds (1767225600), an ISO 8601 date (2026-01-01) or an ISO 8601 date-time with offset (2026-01-01T00:00:00Z). The period is resolved to whole days in the profile time zone; an ISO 8601 date is taken as is. Must not be in the future, and until must be at most 365 days after since.
- Until
untildate and timeRequired - End of the period, inclusive: a Unix timestamp in seconds (1767225600), an ISO 8601 date (2026-01-01) or an ISO 8601 date-time with offset (2026-01-01T00:00:00Z). The period is resolved to whole days in the profile time zone; an ISO 8601 date is taken as is. Must not be in the future, and until must be at most 365 days after since.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Get content report
Get content report.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- Profile uid
profile_uidtextRequired - Profile uid
- Since
sincedate and timeRequired - Start of the period, inclusive: a Unix timestamp in seconds (1767225600), an ISO 8601 date (2026-01-01) or an ISO 8601 date-time with offset (2026-01-01T00:00:00Z). The period is resolved to whole days in the profile time zone; an ISO 8601 date is taken as is. Must not be in the future, and until must be at most 365 days after since.
- Until
untildate and timeRequired - End of the period, inclusive: a Unix timestamp in seconds (1767225600), an ISO 8601 date (2026-01-01) or an ISO 8601 date-time with offset (2026-01-01T00:00:00Z). The period is resolved to whole days in the profile time zone; an ISO 8601 date is taken as is. Must not be in the future, and until must be at most 365 days after since.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}Get inbox item
Get inbox item.
Inputs
- Organization
organization_idnumberRequired - Organization id
- Workspace
workspace_idnumberRequired - Workspace id
- Profile uid
profile_uidtextRequired - Profile uid, as returned by the profiles endpoint
- Item ID
item_idtextRequired - Item id, as returned by the items endpoint. It also resolves the parentId and postId of an item, and the id an history event carries.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": "example"
}
}Get search engagement
Get search engagement.
Inputs
- Organization
organization_idnumberRequired - Organization id
- Workspace
workspace_idnumberRequired - Workspace id
- Search
search_idtextRequired - Id of the listening search the metric is computed on
- Since
sincedate and time - Take into account the items published after this date (inclusive), ISO 8601. Defaults to the start of the day six days ago, so an unbounded request covers the last seven days.
- Until
untildate and time - Take into account the items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks
networkslist - Take into account the items from these social networks onlyOne or more of:
FACEBOOK,INSTAGRAM,TWITTER,LINKEDIN,TIKTOK,YOUTUBE,REDDIT,WEB_NEWS(Web news),WEB_BLOG(Web blog),WEB_FORUM(Web forum). - Sentiments
sentimentslist - Take into account the items with these sentiments onlyOne or more of:
POSITIVE,NEGATIVE,NEUTRAL. - Keyword
keywordtext - Take into account the items whose extracted keywords include this one only, matched exactly and case-insensitively against the values the keywords endpoint returns. An unknown keyword returns an empty result. Items whose keyword extraction found no text or failed carry no keyword and are never counted.
- Competitors
competitorslist - Take into account the items that matched these competitors of a competitive search only. The names are the ones the searches endpoint returns; an unknown name, or a search that is not competitive, is rejected. An item matching two competitors is counted for both.
- Group by
group_bytext - Dimension to break the metric down along. Omit it for the overall figure. DATE returns one group per period step and echoes the granularity, NETWORK one per social network, COMPETITOR one per competitor of a competitive search : and no total, since an item matching two competitors counts in both groups.One of:
DATE,NETWORK,COMPETITOR.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"groups": []
}
}Get search keywords
Get search keywords.
Inputs
- Organization
organization_idnumberRequired - Organization id
- Workspace
workspace_idnumberRequired - Workspace id
- Search
search_idtextRequired - Id of the listening search whose keywords are returned
- Since
sincedate and time - Take into account the items published after this date (inclusive), ISO 8601. Defaults to the start of the day six days ago, so an unbounded request covers the last seven days.
- Until
untildate and time - Take into account the items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks
networkslist - Take into account the items from these social networks onlyOne or more of:
FACEBOOK,INSTAGRAM,TWITTER,LINKEDIN,TIKTOK,YOUTUBE,REDDIT,WEB_NEWS(Web news),WEB_BLOG(Web blog),WEB_FORUM(Web forum). - Sentiments
sentimentslist - Take into account the items with these sentiments only, which is how to read what a search is complained aboutOne or more of:
POSITIVE,NEGATIVE,NEUTRAL. - Keyword
keywordtext - Take into account the items whose extracted keywords include this one only, matched exactly and case-insensitively. The keywords returned are then the ones mentioned alongside it.
- Competitors
competitorslist - Take into account the items that matched these competitors of a competitive search only. The names are the ones the searches endpoint returns; an unknown name, or a search that is not competitive, is rejected.
- Size
sizenumber - Number of keywords to return. Must be between 1 and 100.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"keywords": []
}
}Get search sentiment
Get search sentiment.
Inputs
- Organization
organization_idnumberRequired - Organization id
- Workspace
workspace_idnumberRequired - Workspace id
- Search
search_idtextRequired - Id of the listening search the metric is computed on
- Since
sincedate and time - Take into account the items published after this date (inclusive), ISO 8601. Defaults to the start of the day six days ago, so an unbounded request covers the last seven days.
- Until
untildate and time - Take into account the items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks
networkslist - Take into account the items from these social networks onlyOne or more of:
FACEBOOK,INSTAGRAM,TWITTER,LINKEDIN,TIKTOK,YOUTUBE,REDDIT,WEB_NEWS(Web news),WEB_BLOG(Web blog),WEB_FORUM(Web forum). - Sentiments
sentimentslist - Take into account the items with these sentiments onlyOne or more of:
POSITIVE,NEGATIVE,NEUTRAL. - Keyword
keywordtext - Take into account the items whose extracted keywords include this one only, matched exactly and case-insensitively against the values the keywords endpoint returns. An unknown keyword returns an empty result. Items whose keyword extraction found no text or failed carry no keyword and are never counted.
- Competitors
competitorslist - Take into account the items that matched these competitors of a competitive search only. The names are the ones the searches endpoint returns; an unknown name, or a search that is not competitive, is rejected. An item matching two competitors is counted for both.
- Group by
group_bytext - Dimension to break the metric down along. Omit it for the overall figure. DATE returns one group per period step and echoes the granularity, NETWORK one per social network, COMPETITOR one per competitor of a competitive search : and no total, since an item matching two competitors counts in both groups.One of:
DATE,NETWORK,COMPETITOR.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"groups": []
}
}Get search volume
Get search volume.
Inputs
- Organization
organization_idnumberRequired - Organization id
- Workspace
workspace_idnumberRequired - Workspace id
- Search
search_idtextRequired - Id of the listening search the metric is computed on
- Since
sincedate and time - Take into account the items published after this date (inclusive), ISO 8601. Defaults to the start of the day six days ago, so an unbounded request covers the last seven days.
- Until
untildate and time - Take into account the items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks
networkslist - Take into account the items from these social networks onlyOne or more of:
FACEBOOK,INSTAGRAM,TWITTER,LINKEDIN,TIKTOK,YOUTUBE,REDDIT,WEB_NEWS(Web news),WEB_BLOG(Web blog),WEB_FORUM(Web forum). - Sentiments
sentimentslist - Take into account the items with these sentiments onlyOne or more of:
POSITIVE,NEGATIVE,NEUTRAL. - Keyword
keywordtext - Take into account the items whose extracted keywords include this one only, matched exactly and case-insensitively against the values the keywords endpoint returns. An unknown keyword returns an empty result. Items whose keyword extraction found no text or failed carry no keyword and are never counted.
- Competitors
competitorslist - Take into account the items that matched these competitors of a competitive search only. The names are the ones the searches endpoint returns; an unknown name, or a search that is not competitive, is rejected. An item matching two competitors is counted for both.
- Group by
group_bytext - Dimension to break the metric down along. Omit it for the overall figure. DATE returns one group per period step and echoes the granularity, NETWORK one per social network, COMPETITOR one per competitor of a competitive search : and no total, since an item matching two competitors counts in both groups.One of:
DATE,NETWORK,COMPETITOR.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"groups": []
}
}List competitors
List competitors.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- Profile uid
profile_uidtextRequired - Profile uid
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"data": []
}
}List inbox items
List inbox items.
Inputs
- Organization
organization_idnumberRequired - Organization id
- Workspace
workspace_idnumberRequired - Workspace id
- Profile uids
profile_uidslist - Set of profile UIDs to filter items, at least one is required. Only items from these profiles will be returned.
- Account uids
account_uidslist - Deprecated: use profileUids instead, which takes precedence when both are provided.
- To review
to_reviewtrue/false - Filter items in the To review state: not yet marked reviewed by a team member. Unrelated to approval workflows.
- Labels
labelslist - Filter items by labels. Only items with these labels will be returned.
- Sentiments
sentimentslist - Filter items by sentiment.One or more of:
POSITIVE,NEGATIVE,NEUTRAL. - Types
typeslist - Filter items by type/source. Specify the types of items to retrieve (e.g., organicComment, adsComment, conversation, ...). profileComment and profileMessage return what the profile itself replied, every other value returns incoming items; several values are combined as a union.One or more of:
ADS_COMMENT(Ads comment),ORGANIC_COMMENT(Organic comment),CONVERSATION,MENTION,RATING,REEL_COMMENT(Reel comment),STORY_MENTION_CONVERSATION(Story mention conversation),PROFILE_COMMENT(Profile comment),PROFILE_MESSAGE(Profile message). - Parent IDs
parent_idslist - Filter items by parent, taking the id of an item returned by this endpoint. Returns the children of these items: the comments of a post, the replies of a comment, the messages of a conversation.
- Since
sincedate and time - Filter items created after this date (inclusive). ISO 8601 format.
- Until
untildate and time - Filter items created before this date (inclusive). ISO 8601 format.
- Offset
offsettext - Offset for pagination
- Limit
limitnumber - Maximum number of items to return per page. Must be between 1 and 25.
- Order
ordertext - Sort order for the results. ASC for ascending (oldest first), DESC for descending (newest first).One of:
ASC,DESC.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"items": [],
"offset": "example"
}
}List listening items
List listening items.
Inputs
- Organization
organization_idnumberRequired - Organization id
- Workspace
workspace_idnumberRequired - Workspace id
- Search
search_idtextRequired - Id of the listening search whose items are returned
- Since
sincedate and time - Return items published after this date (inclusive), ISO 8601. Defaults to the start of the day six days ago, so an unbounded request covers the last seven days.
- Until
untildate and time - Return items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks
networkslist - Return items from these social networks onlyOne or more of:
FACEBOOK,INSTAGRAM,TWITTER,LINKEDIN,TIKTOK,YOUTUBE,REDDIT,WEB_NEWS(Web news),WEB_BLOG(Web blog),WEB_FORUM(Web forum). - Sentiments
sentimentslist - Return items with these sentiments onlyOne or more of:
POSITIVE,NEGATIVE,NEUTRAL. - Keyword
keywordtext - Return the items whose extracted keywords include this one only, matched exactly and case-insensitively against the values the keywords endpoint returns. An unknown keyword returns an empty result. Items whose keyword extraction found no text or failed carry no keyword and are never returned.
- Competitors
competitorslist - Return the items that matched these competitors of a competitive search only. The names are the ones the searches endpoint returns; an unknown name, or a search that is not competitive, is rejected. An item matching two competitors is returned for both.
- Offset
offsettext - Offset returned by the previous response, to read the next page
- Limit
limitnumber - Maximum number of items to return per page. Must be between 1 and 25.
- Order by
order_bytext - Field the items are sorted on. DATE for the publication date, ENGAGEMENT for the interactions the item collected.One of:
DATE,ENGAGEMENT. - Order
ordertext - Sort direction. DESC for the highest value first : the newest items, or the most engaging ones : ASC for the lowest.One of:
ASC,DESC.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"items": [],
"offset": "example"
}
}List menu groups
List menu groups.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- V
vtext - API version
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"menuGroups": []
}
}List metric sets
List metric sets.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- Account uids
account_uidsobject - Profiles to scope discovery to; when omitted, every metric set is listed
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}List notes
List notes.
Inputs
- Organization
organization_idnumberRequired - Organization identifier
- Workspace
workspace_idnumberRequired - Workspace identifier
- Since
sincedate and time - Filter notes after this date (ISO date)
- Until
untildate and time - Filter notes before this date (ISO date)
- Profile uids
profile_uidslist - Filter by profile UIDs
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"query": {}
}
}List organizations
List organizations.
Inputs
- V
vtext - API version
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"organizations": []
}
}List profiles
List profiles.
Inputs
- Organization
organization_idtextRequired - Organization id
- Workspace
workspace_idtextRequired - Workspace id
- V
vtext - API version
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"profiles": []
}
}List searches
List searches.
Inputs
- Organization
organization_idnumberRequired - Organization id
- Workspace
workspace_idnumberRequired - Workspace id
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"searches": []
}
}List workspaces
List workspaces.
Inputs
- Organization
organization_idtextRequired - Organization id
- V
vtext - API version
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"workspaces": []
}
}