Archive API docs
esc
    Jump to
    Getting started Token, first query, response Explorer Run queries in the browser items The connection most integrations start with Changelog Additions and deprecations

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

    Input object

    DeepResearchReportInput

    What a Deep Research report runs on and how. Set the source field that matches inputType (VIEW → viewId, CREATOR → creatorId, CAMPAIGN → campaignId, BRAND → brandIds); a field that belongs to another input type is refused.

    Fields

    Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

    brandIds [ID!]
    BRAND: competitor brand UUIDs (competitorBrands). How many brands a report takes is set per template, and a count outside its bounds is refused with the bounds in the message. A single-brand template takes exactly one brand: your own (the entry with isOwnBrand: true) or one competitor. A multi-brand template (e.g. Share of Voice) always includes your own brand, so pass competitors only, at least as many as the template asks for; your own brand is not one of them.
    campaignId ID
    CAMPAIGN: the campaign UUID (campaigns).
    commentCount Int
    Comments read per post when includeComments is true.
    creatorId ID
    CREATOR: the creator UUID (creators).
    from DateWithZone
    BRAND: first day of the window. Defaults to the first day of the previous month.
    includeComments Boolean
    Read the comments under each post, where the template allows (audienceComments).
    includeReplies Boolean
    Also read replies to those comments.
    inputType DeepResearchInputType! required
    What the report runs on. deepResearchTemplates lists which types each template accepts.
    name String
    Report title. Defaults to one derived from the template and source.
    poolSize Int
    BRAND, pooled Share of Voice templates only: candidate posts ranked before the per-brand limit.
    postLimitPerBrand Int
    BRAND: posts read per brand. Defaults to the template's recommendation.
    prompt String
    Extra instructions for the analysis.
    repliesPerParent Int
    Replies read per comment when includeReplies is true.
    replyParentLimit Int
    Comments per post whose replies are read when includeReplies is true.
    socialProfileIds [ID!]
    CREATOR: narrow the report to these of the creator's social profile UUIDs.
    templateSlug String! required
    The template to run, as slug in deepResearchTemplates.
    to DateWithZone
    BRAND: last day of the window. Defaults to the last day of the previous month.
    trackedCommentsOnly Boolean
    Read only the comments this workspace tracks (Social Flirting workspaces).
    viewId ID
    VIEW: the content view UUID (contentViews).