Archive API docs
    Jump to

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

    Object

    Campaign

    A campaign in Archive that groups creators and their content.

    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.

    campaignType CampaignType
    What kind of campaign this is; null for a campaign whose type the API does not expose.
    createdAt DateTime!
    When the campaign was created (UTC).
    creatorsCount Int!
    Creators currently on the roster. Creators added by handle through updateCampaign join it once their background import resolves them; creators added by id join it during the call.
    dateEnd DateTime
    End of the campaign's window (UTC); null when it has none.
    dateStart DateTime
    Start of the campaign's window (UTC); null when it has none.
    excludeCreatorsInOtherVettingCampaigns Boolean
    Whether a VETTING_WORKFLOW campaign skips creators already on another one of the workspace. Null for a campaign of another type, or one created before the option existed.
    externalId String
    The key the campaign was created with through createCampaign; null for a campaign created in the Archive app.
    id ID!
    Unique identifier for the campaign in Archive's system.
    maxMediaItemsPerCreator Int
    Most posts per creator a VETTING_WORKFLOW campaign pulls and reviews (1000000 means no limit). Null for a campaign of another type.
    name String!
    Campaign name as shown in Archive.
    pullLogic CampaignPullLogic
    Whether a CREATOR_MONITORING campaign captures posts carrying any or all of its tagNames. Null for a campaign of another type.
    tagNames [String!]
    Hashtags and mentions a CREATOR_MONITORING campaign narrows capture to, as stored (lowercased, deduplicated); empty captures every post the roster publishes in the window. Null for a campaign of another type.