# Agorapulse

> Read Agorapulse reports, inbox and listening data; discover workspaces and profiles; watch inbox items, notes and listening results.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/agorapulse

## Actions

### Compute metric set

Compute metric set.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- Account uids (`account_uids`, list, required): Profiles (account uids) to compute the metric set for
- Metric set (`metric_set`, text, required): Metric set identifier returned by discovery
- Options (`options`, object): Option values keyed by option name, as advertised in discovery
- Since (`since`, date 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 (`until`, date and time): End date (inclusive) in YYYY-MM-DD format, e.g. 2025-06-30; defaults to today

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Get audience report

Get audience report.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- Profile uid (`profile_uid`, text, required): Profile uid
- Since (`since`, date and time, required): 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 (`until`, date and time, required): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### Get community report

Get community report.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- Profile uid (`profile_uid`, text, required): Profile uid
- Since (`since`, date and time, required): 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 (`until`, date and time, required): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### Get competitor report

Get competitor report.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- Profile uid (`profile_uid`, text, required): Profile uid
- Since (`since`, date and time, required): 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 (`until`, date and time, required): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Get content report

Get content report.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- Profile uid (`profile_uid`, text, required): Profile uid
- Since (`since`, date and time, required): 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 (`until`, date and time, required): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### Get inbox item

Get inbox item.

**Inputs**

- Organization (`organization_id`, number, required): Organization id
- Workspace (`workspace_id`, number, required): Workspace id
- Profile uid (`profile_uid`, text, required): Profile uid, as returned by the profiles endpoint
- Item ID (`item_id`, text, required): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": "example"
  }
}
```

### Get search engagement

Get search engagement.

**Inputs**

- Organization (`organization_id`, number, required): Organization id
- Workspace (`workspace_id`, number, required): Workspace id
- Search (`search_id`, text, required): Id of the listening search the metric is computed on
- Since (`since`, date 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 (`until`, date and time): Take into account the items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks (`networks`, list): Take into account the items from these social networks only. One or more of: `FACEBOOK`, `INSTAGRAM`, `TWITTER`, `LINKEDIN`, `TIKTOK`, `YOUTUBE`, `REDDIT`, `WEB_NEWS` (Web news), `WEB_BLOG` (Web blog), `WEB_FORUM` (Web forum).
- Sentiments (`sentiments`, list): Take into account the items with these sentiments only. One or more of: `POSITIVE`, `NEGATIVE`, `NEUTRAL`.
- Keyword (`keyword`, text): 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 (`competitors`, list): 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_by`, text): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "groups": []
  }
}
```

### Get search keywords

Get search keywords.

**Inputs**

- Organization (`organization_id`, number, required): Organization id
- Workspace (`workspace_id`, number, required): Workspace id
- Search (`search_id`, text, required): Id of the listening search whose keywords are returned
- Since (`since`, date 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 (`until`, date and time): Take into account the items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks (`networks`, list): Take into account the items from these social networks only. One or more of: `FACEBOOK`, `INSTAGRAM`, `TWITTER`, `LINKEDIN`, `TIKTOK`, `YOUTUBE`, `REDDIT`, `WEB_NEWS` (Web news), `WEB_BLOG` (Web blog), `WEB_FORUM` (Web forum).
- Sentiments (`sentiments`, list): Take into account the items with these sentiments only, which is how to read what a search is complained about. One or more of: `POSITIVE`, `NEGATIVE`, `NEUTRAL`.
- Keyword (`keyword`, text): 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 (`competitors`, list): 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 (`size`, number): Number of keywords to return. Must be between 1 and 100.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "keywords": []
  }
}
```

### Get search sentiment

Get search sentiment.

**Inputs**

- Organization (`organization_id`, number, required): Organization id
- Workspace (`workspace_id`, number, required): Workspace id
- Search (`search_id`, text, required): Id of the listening search the metric is computed on
- Since (`since`, date 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 (`until`, date and time): Take into account the items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks (`networks`, list): Take into account the items from these social networks only. One or more of: `FACEBOOK`, `INSTAGRAM`, `TWITTER`, `LINKEDIN`, `TIKTOK`, `YOUTUBE`, `REDDIT`, `WEB_NEWS` (Web news), `WEB_BLOG` (Web blog), `WEB_FORUM` (Web forum).
- Sentiments (`sentiments`, list): Take into account the items with these sentiments only. One or more of: `POSITIVE`, `NEGATIVE`, `NEUTRAL`.
- Keyword (`keyword`, text): 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 (`competitors`, list): 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_by`, text): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "groups": []
  }
}
```

### Get search volume

Get search volume.

**Inputs**

- Organization (`organization_id`, number, required): Organization id
- Workspace (`workspace_id`, number, required): Workspace id
- Search (`search_id`, text, required): Id of the listening search the metric is computed on
- Since (`since`, date 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 (`until`, date and time): Take into account the items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks (`networks`, list): Take into account the items from these social networks only. One or more of: `FACEBOOK`, `INSTAGRAM`, `TWITTER`, `LINKEDIN`, `TIKTOK`, `YOUTUBE`, `REDDIT`, `WEB_NEWS` (Web news), `WEB_BLOG` (Web blog), `WEB_FORUM` (Web forum).
- Sentiments (`sentiments`, list): Take into account the items with these sentiments only. One or more of: `POSITIVE`, `NEGATIVE`, `NEUTRAL`.
- Keyword (`keyword`, text): 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 (`competitors`, list): 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_by`, text): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "groups": []
  }
}
```

### List competitors

List competitors.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- Profile uid (`profile_uid`, text, required): Profile uid

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "data": []
  }
}
```

### List inbox items

List inbox items.

**Inputs**

- Organization (`organization_id`, number, required): Organization id
- Workspace (`workspace_id`, number, required): Workspace id
- Profile uids (`profile_uids`, list): Set of profile UIDs to filter items, at least one is required. Only items from these profiles will be returned.
- Account uids (`account_uids`, list): Deprecated: use profileUids instead, which takes precedence when both are provided.
- To review (`to_review`, true/false): Filter items in the To review state: not yet marked reviewed by a team member. Unrelated to approval workflows.
- Labels (`labels`, list): Filter items by labels. Only items with these labels will be returned.
- Sentiments (`sentiments`, list): Filter items by sentiment. One or more of: `POSITIVE`, `NEGATIVE`, `NEUTRAL`.
- Types (`types`, list): 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_ids`, list): 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 (`since`, date and time): Filter items created after this date (inclusive). ISO 8601 format.
- Until (`until`, date and time): Filter items created before this date (inclusive). ISO 8601 format.
- Offset (`offset`, text): Offset for pagination
- Limit (`limit`, number): Maximum number of items to return per page. Must be between 1 and 25.
- Order (`order`, text): Sort order for the results. ASC for ascending (oldest first), DESC for descending (newest first). One of: `ASC`, `DESC`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "items": [],
    "offset": "example"
  }
}
```

### List listening items

List listening items.

**Inputs**

- Organization (`organization_id`, number, required): Organization id
- Workspace (`workspace_id`, number, required): Workspace id
- Search (`search_id`, text, required): Id of the listening search whose items are returned
- Since (`since`, date 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 (`until`, date and time): Return items published before this date (inclusive), ISO 8601. Defaults to the end of the current day.
- Networks (`networks`, list): Return items from these social networks only. One or more of: `FACEBOOK`, `INSTAGRAM`, `TWITTER`, `LINKEDIN`, `TIKTOK`, `YOUTUBE`, `REDDIT`, `WEB_NEWS` (Web news), `WEB_BLOG` (Web blog), `WEB_FORUM` (Web forum).
- Sentiments (`sentiments`, list): Return items with these sentiments only. One or more of: `POSITIVE`, `NEGATIVE`, `NEUTRAL`.
- Keyword (`keyword`, text): 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 (`competitors`, list): 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 (`offset`, text): Offset returned by the previous response, to read the next page
- Limit (`limit`, number): Maximum number of items to return per page. Must be between 1 and 25.
- Order by (`order_by`, text): Field the items are sorted on. DATE for the publication date, ENGAGEMENT for the interactions the item collected. One of: `DATE`, `ENGAGEMENT`.
- Order (`order`, text): 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**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "items": [],
    "offset": "example"
  }
}
```

### List menu groups

List menu groups.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- V (`v`, text): API version

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "menuGroups": []
  }
}
```

### List metric sets

List metric sets.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- Account uids (`account_uids`, object): Profiles to scope discovery to; when omitted, every metric set is listed

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### List notes

List notes.

**Inputs**

- Organization (`organization_id`, number, required): Organization identifier
- Workspace (`workspace_id`, number, required): Workspace identifier
- Since (`since`, date and time): Filter notes after this date (ISO date)
- Until (`until`, date and time): Filter notes before this date (ISO date)
- Profile uids (`profile_uids`, list): Filter by profile UIDs

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "query": {}
  }
}
```

### List organizations

List organizations.

**Inputs**

- V (`v`, text): API version

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "organizations": []
  }
}
```

### List profiles

List profiles.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- Workspace (`workspace_id`, text, required): Workspace id
- V (`v`, text): API version

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "profiles": []
  }
}
```

### List searches

List searches.

**Inputs**

- Organization (`organization_id`, number, required): Organization id
- Workspace (`workspace_id`, number, required): Workspace id

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "searches": []
  }
}
```

### List workspaces

List workspaces.

**Inputs**

- Organization (`organization_id`, text, required): Organization id
- V (`v`, text): API version

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "workspaces": []
  }
}
```
