Feeds
Last updated
Was this helpful?
Last updated
Was this helpful?
Retrieve a list of feed items based on the specified parameters.
Limits the number of results to return
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
Return only the count of the results, not the results themselves
The results can optionally be sorted by one of these fields.
createdAt, lastActivity, lastMessageByContact, slaExpiresThe type of feed.
channel, participant, team, agent, custom, view, privateview, taskThe id for indexType.
Filter by specific root item IDs (conversation IDs or conference IDs, or a combination of both).
The feed item type.
conversation, conference, taskThe feed item type.
Filter by specific ticket number.
Search for feed items that have no agent assigned.
The id of the agent(s) assigned to this item.
The id of the team(s) assigned to this item.
Whether to include closed feed items or not. All items are included by default
Whether to include seen feed items or not. All items are included by default
Whether to include archived feed items or not. All items are included by default
Search for feed items containing these tags.
Filter items for a specific conversation(s).
Filter items for a specific conversation name containing the term.
Filter items for a specific conversation channel(s).
Filter items with a specific conversation status(es).
Filter items with a specific conference status(es).
Participant IDs for conversation feed items.
The types of participants in a conversation. It can be used for example to find out if there was any agent interaction in the conversation. This filter additionally filters out non-conversation feed items.
If specified, matched conversations will not contain participants of these types. It can be used for example to find out if there was NO agent interaction in the conversation.
The participant type that sent the last message in this feed item. It can match any of the specified types. This filter additionally filters out non-conversation feed items.
user, contact, agent, flow, channel, connectorFilter items with a specific status(es).
Find messages created after this date.
Find messages created before this date.
If specified, matched conversations will contain one of the search terms in one of its fields. searchTerm will be split into individual terms, and filter items accordingly. This can be used, for example, to find items with specific conversationName and ticketNumbers. If specified between quotes, matched conversations will contain the whole phrase on conversationName or in the conversation body.
Find messages with the SLA policy attached.
Find messages that have a SLA policy attached.
Reflects the overall state of the SLA policy on a ticket.
ok: all metrics are green.needsAttention: one or more metrics are in a warning state.breached: one or more metrics are in a breached state.ok, needsAttention, breachedFind messages with an active SLA timer for this metric.
firstReplyTime, nextReplyTimeFind message with a SLA timer with this status.
active, expiredFind message where the next SLA breach is before this date.
Find message where the next SLA breach is after this date.
Retrieve the feed for a specific channel, participant, or team, containing updates, and interactions.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Permanently delete a feed.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
No body
Obtain a list of items within the feed.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Limits the number of results to return
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
Sort applied to the list
lastActivity, lastMessageByContact, createdAt, slaExpiresFilter by specific ticket number.
Search for feed items that have no agent assigned.
The id of the agent(s) assigned to this item.
The id of the team(s) assigned to this item.
Whether to include closed feed items or not. All items are included by default
Whether to include seen feed items or not. All items are included by default
Whether to include archived feed items or not. All items are included by default
Search for feed items containing these tags.
Filter items for a specific conversation(s).
Filter items for a specific conversation channel(s).
Filter items for a specific conversation name containing the term.
Filter items with a specific conversation status(es).
Filter items with a specific conference status(es).
Participant IDs for conversation feed items.
The types of participants in a conversation. It can be used for example to find out if there was any agent interaction in the conversation. This filter additionally filters out non-conversation feed items.
If specified, matched conversations will not contain participants of these types. It can be used for example to find out if there was NO agent interaction in the conversation.
The participant type that sent the last message in this feed item. It can match any of the specified types. This filter additionally filters out non-conversation feed items.
user, contact, agent, flow, channel, connectorFilter items with a specific status(es).
Obtain a list of items within the feed of currently logged in agent.
Limits the number of results to return
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
Retrieve information about a specific item within a feed.
Feed Item UUID
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Removes an item from a feed.
Feed Item UUID
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
No body
Retrieve a list of custom and view feeds for administration purposes.
Limits the number of results to return
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
The type of feed.
channel, participant, team, agent, custom, view, privateview, taskCreate a custom feed or view feed for a given workspace.
custom, view, privateviewRetrieve a list of feed items based on the specified parameters.
Limits the number of results to return
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
Return only the count of the results, not the results themselves
createdAt, lastActivity, lastMessageByContact, slaExpiresReturn only the count of the results, not the results themselves
channel, participant, team, agent, custom, taskconversation, conference, taskSearch for feed items that have no agent assigned.
noFollowUp, noCustomerReply, noAgentReplyReflects the overall state of the SLA policy on a ticket.
ok: all metrics are green.needsAttention: one or more metrics are in a warning state.breached: one or more metrics are in a breached state.ok, needsAttention, breachedfirstReplyTime, nextReplyTimeactive, expiredIf true, only return spam. Otherwise, only non-spam.
Perform an update on a given feed.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Perform bulk updates on multiple items within a feed, modifying their content, status, or other attributes.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
No body
Modify the content of a specific item within a feed.
Feed Item UUID
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
AgentAssignedSkill is a denormalized AgentSkill, and a part of Agent entity.
The slug of the status to set on the feed item.
Add an existent item to an existent feed.
Feed Item UUID
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'
Merges the feed item in the URL into the one specified in the request body.
Represents an identifier for feed or feed contents. Supported formats ':' or '::', for example 'channel:747d7564-9ec1-461a-ad3a-2a3a55124917' or 'participant:contact:c453186d-c1e1-494d-9176-1673e1a542ee'