Queries
Read operations exposed by the Archive GraphQL API, grouped by functional area.
Workspaces
- workspace
- Return details for the current workspace, inferred from the WORKSPACE-ID header.
- workspaces
- List all workspaces that the current API user has access to.
Items & Media
- itemIdsByUrl
- Look up item IDs by social media URLs within the current workspace. Accepts any public HTTP(S) URL. INVALID_URL is returned only for malformed / non-HTTP URLs or private/reserved hosts; a valid public URL we cannot resolve (unrecognized shape, short link, or no matching item) returns NOT_FOUND. Recognized shapes (non-exhaustive hint): 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
- Retrieve media contents (images / videos) for shop items (
itemIds) or forCompetitorBrandItemrows (competitorBrandItemIds). Pass exactly one. See the resolver description for routing details. - transcriptions
- Fetch transcriptions for one or more media contents belonging to the current workspace.
Creators & Social Profiles
- creator
- Return details for the creator.
- creators
- List and paginate creators for the current workspace, ordered newest first.
- socialProfile
- Return details for a social profile by ID or account identifier.
- 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
- Paginated history of engagement metric snapshots for a specific item, ordered newest first.
Campaigns
- campaigns
- List and paginate campaigns for the current workspace, ordered newest first. Workflow-type rows are excluded to match 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. Also resolves the workspace's own-brand entry by its stable id. Pair with
competitorBrandItems(brandId:, filter:, …)to paginate the brand's media items. If aggregate metrics are unavailable, roster data remains and the response includes aSERVICE_UNAVAILABLEerror; match onextensions.codeand retry later. - competitorBrandItems
- Paginate Competitor Insights posts for a brand within a required
filter.takenAtwindow. Posts for a given month become queryable on day 9 of the following month. - competitorBrands
- List Competitor Insights brands tracked by the current workspace, ordered newest first, with aggregate metrics over a
period/datewindow (default month). The workspace's own-brand entry is returned as one additional pinned node on the first page (flaggedisOwnBrand), in addition to up tofirstcompetitor brands, so self-vs-competitor Share of Voice is computable in-query;totalCountcounts tracked competitor brands only. Pair withcompetitorBrandItems(brandId:, filter:, …)to paginate a brand's media items. If aggregate metrics are unavailable, roster data remains and the response includes 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 (media deck) view by ID for the current workspace, or null if no such view exists here. Pair with
items(presetId:)to fetch the items belonging to a view. - contentViews
- List saved content (media deck) views for the current workspace, ordered by most-recently-updated first. Pair with
items(presetId:)to fetch the items belonging to a view. 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 the creators belonging to a view. - creatorViews
- List saved Creator Views for the current workspace, ordered by most-recently-updated first. Pair with
creators(presetId:)to fetch the creators belonging to a view. 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.
- socialProfileViews
- List saved Social Profile views for the current workspace, ordered by most-recently-updated first. 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
- Retrieve custom attribute schemas to interpret customAttributes values. 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 details for an operation by ID, including 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 (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
- Cursor-paginated variant of webhookSubscriptions: list outbound-webhook subscriptions for the current workspace, newest first.