Archive API docs
    Jump to

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Read tools

    42 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 →
    Find and rank archived Instagram, TikTok, and YouTube content in the current workspace.
    searchCreators wraps creators →
    Find tracked creators and influencers by handle, campaign, location, or custom fields in the current workspace.
    getCreator wraps creator →
    Read one creator's current CRM custom fields, and optionally their change history, by Archive id.
    getCompetitorBrands wraps competitorBrands →
    Compare the workspace's brand with tracked competitors using period-level content, creator, reach, engagement, and earned-media metrics.
    getCompetitorBrand wraps competitorBrand →
    Read period-level performance metrics for one tracked competitor or the workspace's own brand.
    getCompetitorBrandItems wraps competitorBrandItems →
    Find archived posts for one tracked competitor brand within a required publication window.
    getCustomAttributeSchemas wraps customAttributeSchemas →
    Discover custom-field names, types, and select options for workspace content, creators, or campaign roster entries.
    getMediaContents wraps mediaContents →
    Get image, video, and thumbnail URLs for archived workspace posts or tracked Competitor Insights posts.
    getTranscriptions wraps transcriptions →
    Read available transcripts of archived workspace videos to understand what creators say.
    getCampaigns wraps campaigns →
    Find campaigns in the current workspace and resolve their ids, newest first.
    getCampaign wraps campaign →
    Inspect one campaign's type, tracking dates, capture tag rules, externalId, and current roster size in the workspace.
    getCampaignCreators wraps campaignCreators →
    Find creators on a campaign roster and inspect their campaign-specific workflow status.
    getOperations wraps operations →
    Find recent background imports, engagement refreshes, and supported label operations in the workspace, newest first.
    getEngagementHistory wraps engagementHistory →
    Track how an archived post's engagement changes over time using recorded metric snapshots, newest first.
    getWorkspace wraps workspace →
    Inspect a workspace's tracked hashtags, mentions, keywords, and connected social accounts in one call.
    getWorkspaces no workspace wraps workspaces →
    Find the brands and workspaces the authenticated caller can access, with their tracking configuration and connected accounts.
    getSocialProfile external call wraps socialProfile →
    Look up one social account by profile id or platform and handle, including available contact details and follower counts.
    getSocialProfiles wraps socialProfiles →
    Browse tracked Instagram, TikTok, and YouTube accounts with available contact details, follower counts, and optional content statistics.
    getContentViews wraps contentViews →
    Find reusable saved content searches in the workspace, ordered most-recently-updated first.
    getContentView wraps contentView →
    Read one saved Content View's filters, custom conditions, sorting, and display settings.
    getOperation wraps operation →
    Check the progress, outcome, and available error summaries of one background operation in the current workspace.
    getOperationRecords wraps operationRecords →
    Inspect individual successes, failures, and pending records within a background operation, newest first.
    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 →
    Find saved Social Profile Views for reusable account segments, ordered most-recently-updated first.
    getSocialProfileView wraps socialProfileView →
    Inspect one saved Social Profile View's custom conditions, sorting, and display settings.
    getCreatorViews wraps creatorViews →
    Find saved creator segments in the workspace, ordered most-recently-updated first.
    getCreatorView wraps creatorView →
    Inspect one saved Creator View's custom conditions, sorting, and display settings.
    getViewGroups wraps viewGroups →
    Find the workspace's user-created folders for organizing saved views and Collections, ordered oldest-first.
    getViewGroup wraps viewGroup →
    Inspect a workspace view group's member views and Collections in their display order.
    getCollections wraps collections →
    Find named Collections of selected workspace posts, including their item counts, in saved display order.
    getCollection wraps collection →
    Inspect one Collection's name, item count, and view group in the current workspace.
    getItemIdsByUrl wraps itemIdsByUrl →
    Find the Archive item ids for public social post URLs supplied by the user.
    getLabels wraps labels →
    Find existing creator labels to interpret tags, reuse a segment name, or avoid creating duplicate labels. Labels are workspace-scoped and sorted alphabetically by name (case-insensitive). Symbols and emoji follow the database collation, not code-point order (e.g. "zz-🎉" sorts before "zz-alpha").
    getLocationGroups wraps locationGroups →
    Resolve geographic groups such as the European Union, DACH, continents, and UN regions into supported location-filter codes.
    getWebhookSubscriptions wraps webhookSubscriptionsConnection →
    Inspect configured webhook endpoints, subscribed events, pause state, and delivery health in the current workspace.
    getWebhookDeliveries wraps webhookDeliveries →
    Diagnose webhook delivery failures using attempt counts, the latest response status and error, and retry timing. Deliveries are newest first.
    getWebhookEvents wraps webhookEvents →
    Read recent webhook event payloads to reconcile missed or dropped deliveries in the current workspace.
    getWebhookLimits wraps webhookLimits →
    Get the workspace's outbound-webhook caps and its current usage, so you can check headroom before createWebhookSubscription / updateWebhookSubscription instead of hitting a limit userError.
    getDeepResearchTemplates wraps deepResearchTemplates →
    Discover which Deep Research analyses this workspace can run for content views, creators, campaigns, or brands.
    getDeepResearchQuote wraps deepResearchQuote →
    Estimate a Deep Research report's credit cost and check affordability before starting it, without spending credits.
    getDeepResearchReports wraps deepResearchReports →
    Find existing Deep Research reports and their status in the current workspace, newest first.
    getDeepResearchReport wraps deepResearchReport →
    Read a Deep Research report's full analysis and share link, or check progress while it runs.