Archive API docs

Read tools

32 tools that only fetch data. Each wraps one public GraphQL query field and executes it verbatim, so the arguments, filters, and result shapes are the ones documented on that field's reference page.

Read tools are annotated readOnlyHint: true and idempotentHint: true, so an agent may retry one freely. They are available to every valid credential, including an OAuth connection without the write scope.

searchItems wraps items

Search archived social content (Instagram, TikTok, YouTube) for the current workspace.

searchCreators wraps creators

Search creators (influencers) tracked for the current workspace, newest first.

getCreator wraps creator

Look up a single creator (influencer) by id in the current workspace.

getCompetitorBrands wraps competitorBrands

List Competitor Insights brands tracked for the current workspace, newest first, with aggregate metrics over a period/date window, so self-vs-competitor Share of Voice is computable in one call.

getCompetitorBrand wraps competitorBrand

Look up a single Competitor Insights brand by id in the current workspace, with aggregate metrics over a period/date window. Also resolves the workspace's own brand by its stable id (isOwnBrand: true).

getCompetitorBrandItems wraps competitorBrandItems

Paginate posts attributed to a single tracked Competitor Insights brand within a required `takenAt` time window.

getCustomAttributeSchemas wraps customAttributeSchemas

List custom attribute schemas for the current workspace, used both to INTERPRET values in the `customAttributes` JSON field on items/creators AND to BUILD `customAttributeConditions` filters for searchItems / searchCreators.

getMediaContents wraps mediaContents

Retrieve media contents (images / videos) for shop items OR for tracked Competitor Insights items in the current workspace.

getTranscriptions wraps transcriptions

Fetch transcriptions for the media contents of one or more shop items in the current workspace.

getCampaigns wraps campaigns

List campaigns for the current workspace, newest first.

getOperations wraps operations

List operations for the current workspace, newest first. Only `refetch_engagement` operation type is listed here; an operation id visible via getOperation may be absent from this list if it is of another internal type.

getEngagementHistory wraps engagementHistory

Paginated history of engagement metric snapshots for a single item, newest first.

getWorkspace wraps workspace

Get a workspace — its tracked hashtags/mentions/keywords and connected social integrations — in one call. The workspace is selected by the optional `workspaceId` argument (falling back to the `WORKSPACE-ID` header, or your sole workspace when you can access exactly one). Call getWorkspaces first to discover the ids you can access.

getWorkspaces no workspace wraps workspaces

List all workspaces the authenticated caller can access, newest first.

getSocialProfile external call wraps socialProfile

Look up ONE social profile (influencer) in the current workspace. For MANY profiles do NOT loop this per id — call getSocialProfiles once to list/filter a whole page of profiles in a single call (the batch path).

getSocialProfiles wraps socialProfiles

List social profiles (Instagram / TikTok / YouTube accounts) tracked for the current workspace, profiles with the most recent content first. This is the batch / multi-profile path — reach for it instead of calling getSocialProfile once per id when you need more than one profile.

getContentViews wraps contentViews

List saved content (media deck) views for the current workspace, ordered most-recently-updated first.

getContentView wraps contentView

Look up a single saved content (media deck) view by id in the current workspace.

getOperation wraps operation

Look up a single async operation by id in the current workspace — poll its status and progress (e.g. after refetchEngagementBulk).

getFilterPresets deprecated wraps filterPresets

DEPRECATED — prefer the typed view tools getContentViews (accessor MEDIA_DECK) and getCollections (accessor COLLECTIONS); their ids work the same way as a presetId input. This tool still lists saved filter presets for the current workspace (no removal window announced), but new integrations should not adopt it. Use the returned id as `presetId:` when calling items(...) to scope a search to the preset's saved filter set.

Use contentViews / socialProfileViews / creatorViews / campaignCreatorViews / collections instead.

getSocialProfileViews wraps socialProfileViews

List saved Social Profile views for the current workspace, ordered most-recently-updated first.

getSocialProfileView wraps socialProfileView

Look up a single saved Social Profile view by id in the current workspace.

getCreatorViews wraps creatorViews

List saved Creator Views for the current workspace, ordered most-recently-updated first.

getCreatorView wraps creatorView

Look up a single saved Creator View by id in the current workspace.

getViewGroups wraps viewGroups

List user-created view groups for the current workspace, ordered oldest-first.

getViewGroup wraps viewGroup

Look up a single user-created view group by id in the current workspace, including its member views.

getCollections wraps collections

List Collections (saved tag sets) for the current workspace, in the workspace's saved display order.

getCollection wraps collection

Look up a single Collection (saved tag set) by id in the current workspace.

getItemIdsByUrl wraps itemIdsByUrl

Resolve public social-media post URLs to shop-item UUIDs in the current workspace.

getWebhookSubscriptions wraps webhookSubscriptionsConnection

List outbound-webhook subscriptions for the current workspace, newest first. The id-resolution source for updateWebhookSubscription / deleteWebhookSubscription / rotateWebhookSubscriptionSecret / sendWebhookTestEvent / enableWebhookSubscription — resolve subscription ids here, never guess.

getWebhookDeliveries wraps webhookDeliveries

Paginate webhook deliveries (the dead-letter / observability surface) for the current workspace, newest first. THE source for redeliverWebhookDelivery's required `deliveryId` — filter by status "FAILED" and pick the delivery's `id`; never guess ids.

getWebhookEvents wraps webhookEvents

Paginate webhook events (the outbox — the Stripe /v1/events pattern) for the current workspace, newest first. The reconciliation surface: query it to recover business events whose deliveries were DROPPED or missed; an event's `id` doubles as its idempotency key.