Inbox

BETA

Access to Inbox API features is currently in beta. Please contact support to request access.

The organization must have an active Inbox subscription and an Inbox Large, Custom, or Agency tier.

Public fan comments

The Inbox API provides access to public fan comments in Swat.io.

Private messages and comments authored by the page are excluded.

Regular Inbox permissions of the users token apply.

List comments

inboxCommentFanList returns up to 50 comments, ordered by newest real_created value first. Optional filters combine with AND. Multiple filter_comment_tags values combine with OR.

query listInboxCommentFans {
  inboxCommentFanList(
    workspace_id: <WORKSPACE_ID>
    channel_ids: [<CHANNEL_ID>]
    filter_comment_tags: ["important", "product-feedback"]
  ) {
    comments {
      id
      
      deleted
      is_hidden
      message
      post_id
      real_created
      sentiment
      tags
      
      attachments {
        category
        description
        link
        source
        title
      }
      channel {
        id
      }
      profile {
        id
        channel_type
        name
        network_handle
      }
      ticket {
        id
      }
    }
    pagination {
      after
    }
  }
}

To retrieve the next page, pass the returned pagination.after value as the after argument and keep every other argument unchanged.

profile_ids identify a social-media profile across its channel-specific profile occurrences in the workspace.

Summarize a profile's comments

inboxCommentFanProfileSummary aggregates matching comments for one social media profile. channel_ids and filter_comment_tags optionally narrow the aggregate.

query summarizeInboxCommentFanProfile {
  inboxCommentFanProfileSummary(
    workspace_id: <WORKSPACE_ID>
    profile_id: <PROFILE_ID>
  ) {
    comment_count
    comment_real_created_first
    comment_real_created_last
    total_negative_sentiment_count
    total_neutral_sentiment_count
    total_positive_sentiment_count
    
    profile {
      id
      channel_type
      name
      network_handle
      link
      picture
    }
  }
}