Queries
Read operations exposed by the Archive GraphQL API, grouped by functional area.
Workspaces
- workspace
- Return the current workspace, identified by the WORKSPACE-ID header.
- workspaces
- List every workspace the current API user can access.
Items & Media
- itemIdsByUrl
- Look up item IDs by social media URL within the current workspace. Accepts any public HTTP(S) URL. INVALID_URL means a malformed or non-HTTP URL, or a private/reserved host. A valid public URL that does not resolve returns NOT_FOUND: an unrecognized shape, a short link, or no matching item. Recognized shapes (not exhaustive): Instagram (/p/, /reel/, /reels/), TikTok (@user/video/{id}, @user/photo/{id}), and YouTube (/shorts/, /watch?v=, youtu.be/).
- items
- Search and paginate archived items (social content) for the current workspace.
- mediaContents
- Return media contents (images / videos) for items or Competitor Insights posts. Pass exactly one of
itemIdsorcompetitorBrandItemIds; both, or neither, is a GraphQL error.itemIdsmust belong to the current workspace.competitorBrandItemIdscome fromcompetitorBrandItems; posts of a brand the workspace does not track return no rows. - transcriptions
- Return transcriptions for media contents in the current workspace. Pass either
mediaContentIdsoritemIds, not both.
Creators & Social Profiles
- creator
- Return a single creator by ID for the current workspace.
- creators
- List and paginate creators for the current workspace, ordered newest first.
- socialProfile
- Return a single social profile by ID or account identifier for the current workspace.
- socialProfiles
- List and paginate social profiles for the current workspace. Pass
presetId(a Social Profile View id fromsocialProfileViews/socialProfileView) to drive results off the view's stored conditions and sort. Otherwise narrow withfilter.
Engagement
- engagementHistory
- Paginate engagement metric snapshots for one item, newest first.
Campaigns
- campaigns
- List and paginate campaigns for the current workspace, ordered newest first. Workflow-type campaigns are excluded, matching the in-app CRM listing.
Competitor Insights
- competitorBrand
- Return a single Competitor Insights brand by ID for the current workspace, or null if no brand with that ID is tracked here. The workspace's own-brand entry also resolves, by its stable id. Pair with
competitorBrandItems(brandId:, filter:, …)to paginate the brand's media items. When aggregate metrics are unavailable, the roster data still returns, with aSERVICE_UNAVAILABLEerror. Match onextensions.codeand retry later. - competitorBrandItems
- Paginate Competitor Insights posts for a brand within a required
filter.takenAtwindow. Posts for a month become queryable on day 9 of the following month. - competitorBrands
- List Competitor Insights brands tracked by the current workspace, newest first. Each brand carries aggregate metrics over a
period/datewindow (default month). The first page also returns the workspace's own brand as one pinned node, flaggedisOwnBrand. It comes in addition to up tofirstcompetitor brands, so one query gives self-vs-competitor Share of Voice.totalCountcounts tracked competitor brands only. Pair withcompetitorBrandItems(brandId:, filter:, …)to paginate a brand's media items. When aggregate metrics are unavailable, the roster data still returns, with aSERVICE_UNAVAILABLEerror. Match onextensions.codeand retry later.
Collections
- collection
- Return a single Collection by ID for the current workspace, or null if no such Collection exists here.
- collections
- List Collections (saved tag sets) for the current workspace, in the workspace's saved order. Returns at most 1000 rows; this field is not paginated.
Views & View Groups
- contentView
- Return a single saved Content View by ID for the current workspace, or null if no such view exists here. Pair with
items(presetId:)to fetch its items. - contentViews
- List saved Content Views for the current workspace, most-recently-updated first. Pair with
items(presetId:)to fetch a view's items. Returns at most 1000 rows; this field is not paginated. - creatorView
- Return a single saved Creator View by ID for the current workspace, or null if no such view exists here. Pair with
creators(presetId:)to fetch its creators. - creatorViews
- List saved Creator Views for the current workspace, most-recently-updated first. Pair with
creators(presetId:)to fetch a view's creators. Returns at most 1000 rows; this field is not paginated. - socialProfileView
- Return a single saved Social Profile View by ID for the current workspace, or null if no such view exists here. Pair with
socialProfiles(presetId:)to fetch its social profiles. - socialProfileViews
- List saved Social Profile Views for the current workspace, most-recently-updated first. Pair with
socialProfiles(presetId:)to fetch a view's social profiles. Returns at most 1000 rows; this field is not paginated. - viewGroup
- Return a single user-created view group by ID for the current workspace, or null if no such group exists here.
- viewGroups
- List user-created view groups for the current workspace, ordered oldest-first. Returns at most 1000 rows; this field is not paginated.
Custom Attributes
- customAttributeSchemas
- List the custom attribute schemas that interpret
customAttributesvalues. Returns at most 1000 rows; this field is not paginated.
Filtering
- filterPresets deprecated
- List saved filter presets for items queries in the current workspace. Returns at most 1000 rows; this field is not paginated.
Async Operations
- operation
- Return an operation by ID, including its status and progress.
- operationRecords
- Paginate the per-item records of an operation, newest first. Optionally filter by record status.
- operations
- List operations for the current workspace, ordered newest first.
Webhooks
- webhookDeliveries
- Paginate webhook deliveries (the dead-letter surface) for the current workspace, newest first. Filter by subscription and/or status. History is retained for 30 days.
- webhookEvents
- Paginate webhook events (the outbox) for the current workspace, newest first. Filter by event type. History is retained for 30 days.
- webhookSubscriptions
- List outbound-webhook subscriptions for the current workspace, newest first. Returns at most 1000 rows; this field is not paginated.
- webhookSubscriptionsConnection
- Paginate outbound-webhook subscriptions for the current workspace, newest first. The cursor-paginated variant of
webhookSubscriptions.