Skip to main content

GraphQL API

The GraphQL surface covers the full application model: projects, flags, workflows, analytics, messaging, cohorts and billing. Requests need an access token.

JSON
{
  "method": "POST",
  "url": "https://api.prodantix.com/graphql",
  "headers": { "Authorization": "Bearer <access token>" }
}

GraphiQL playground

A graphical explorer is served at GET https://api.prodantix.com/graphql. Use it to browse the schema; running a query still needs a token.

https://api.prodantix.com/graphql

Schema roots

RootField count
Query286
Mutation421
Subscription26
RootFields
Queryping · me · flags · archivedFlags · experiments · experiment · experimentResults · flagHistory · flagRollouts · flagChangeRequests · flagChangeRequest · flagReviewRequired · promotionDiff · workflowAnalytics · workflowHealth · workflowFolders · workflowStarters · workflowTemplates · workflowHook · workflowDefinitions · workflowDefinitionStats · workflowDefinition · workflowRuns · workflowRunsPage · workflowRunSteps · workflowVersionGraph · workflowRun · health · runSql · runQuery · runFunnel · runRetention · runPaths · pathsPages · runStickiness · runLifecycle · aiTranslateQuery · aiAnswer · aiInsights · aiSettings · aiAccount · aiAccountModels · aiSeats · aiEnabled · aiModels · aiLimits · aiUsage · aiSpendByMonth · aiUsageMonths · aiMembers · aiCardOnFile · aiWhitelisted · aiLimitSuggestion · projects · projectGroups · projectAllowance · replaySessions · replayChunks · events · eventCatalog · messages · billingState · billingStanding · tierLimits · planAllowance · planFeature · planMeterBlocked · billingPlanChangePreview · addOns · heldAddOns · addOnPreview · dashboards · dashboardTemplates · insights · crossedInsightWatches · reports · report · reportVersions · annotations · annotationTags · propertyDefinitions · propertyDataQuality · propertyGroups · associationLabels · personLinkLabels · companyLinkLabels · savedViews · savedView · crmTimeline · crmTasks · crmTags · crmRecordTags · crmLifecycleRules · crmRoutingRules · crmStageCounts · crmLifecycleReport · crmLifecycleBackwards · crmImports · crmImport · crmExports · crmExportCount · crmExport · crmScores · crmScoreDistribution · crmScoreHistory · crmPipelines · crmReportingCurrency · crmDeals · crmDeal · crmDealReports · crmDuplicates · crmAutoMerge · crmFormatRules · crmFormatIssues · crmFormatIssueCounts · crmDataQualityCounts · crmPropertyHealth · reportPublicLink · reportEndpoints · reportCommentThreads · reportCommentEarlierReplies · cohorts · cohort · cohortMembers · cohortMemberCount · projectPeople · projectPeopleGroups · projectPerson · organisationMembers · pendingInvitations · organisationRoles · assignableRoles · viewerIsOperator · operatorTenants · operatorUsage · operatorSubscriptions · operatorVolumeChanges · operatorTenantDetail · operatorTenantProjects · operatorTenantMembers · operatorMembers · operatorHolders · operatorExemptions · operatorTenantBilling · conversations · conversationDraft · myReplyUndoSeconds · conversationDuplicatePeople · supportAddress · supportAddressLastReceivedAt · conversationParticipants · slackInboxChannels · whatsappTemplates · myEmailSignature · supportReplyFrom · conversationDuplicates · inboxDashboard · macros · macroPreview · inboxAssignment · inboxViews · inboxViewCounts · inboxViewConversations · conversationAttributeDefinitions · conversationCounts · builtInAiEnabled · conversation · messengerConfig · messengerTeam · myMessengerProfile · messengerAssistant · messengerHelpCentre · messengerArticleReport · messengerArticleGaps · tenantStorage · aiProposals · myAccounts · myGrants · myCompanies · integrationProviders · integrationConnections · slackChannels · copyPlan · agentAccess · agentConnections · scimTokens · companySignInRules · myClientAddress · auditEvents · companyClosure · companyExport · companySsoConnection · warehouseDestinations · warehouseRuns · warehouseSources · warehouseModels · previewWarehouseModel · warehouseModelRuns · surveys · survey · surveyTemplate · surveyResponseCounts · surveyResults · guides · guide · guideReach · guideResults · ticketTypes · ticketStates · tickets · ticket · ticketNotes · slaPolicies · slaRules · slaClocks · slaClocksFor · ingestTransformations · ingestTransformationChanges · testIngestTransformations · projectDomains · crmForms · crmForm · crmFormSubmissions · crmFormTotals · crmFormAnalytics · crmCtas · crmCta · crmCtaReport · crmCtaTotals · crmPages · crmPage · crmPageReport · crmPageTotals · crmConsentBanner · crmPersonConsents · emailDomains · emailCompanySettings · emailSubscriptionTypes · emailSuppressions · emailHealth · personEmailSubscriptions · marketingEmails · marketingEmail · marketingEmailReadiness · marketingEmailPreview · marketingEmailReport · marketingEmailAudience · emailTemplates · emailBrandKit · emailSendingSettings · pushApps · smsConnection · smsOptOuts · smsMeasure · channelMessages · channelMessage · channelMessageReadiness · channelMessageReport · cohortSyncCounts · cohortSyncs · cohortFolders · cohortMakeup · cohortOverlap · cohortJourney · previewCohortDefinition · cohortLookalikes · cohortLookalike · eventStreams · endUserErasure · endUserExport · sideConversations · sideConversation · marketingCampaigns · marketingCampaign · marketingCampaignAssets · marketingCampaignSpend · marketingTrackingUrls · marketingCampaignCalendar · marketingCampaignViews · marketingAttribution · marketingCampaignReport · marketingCampaignNumbers · marketingJourney · marketingEvents · marketingEvent · marketingEventPeople
MutationupsertFlag · archiveFlag · restoreFlag · createExperiment · updateExperiment · startExperiment · stopExperiment · concludeExperiment · deleteExperiment · startFlagRollout · cancelFlagRollout · rollbackFlagRollout · setFlagReviewRequired · setIdentityLinkEnabled · proposeFlagChange · approveFlagChange · rejectFlagChange · withdrawFlagChange · promoteFlag · createWorkflowFolder · renameWorkflowFolder · deleteWorkflowFolder · moveWorkflowToFolder · createWorkflowFromStarter · createWorkflowFromTemplate · saveWorkflowAsTemplate · deleteWorkflowTemplate · rotateWorkflowHookSecret · createWorkflowDefinition · updateWorkflowDefinition · saveCanvasLayout · setWorkflowEnabled · deleteWorkflowDefinition · publishWorkflowVersion · fireWorkflow · signalWorkflow · cancelWorkflow · registerDeviceToken · unregisterDeviceToken · requestAccountDeletion · cancelAccountDeletion · composeMessage · startBillingCheckout · changeBillingPlan · cancelBillingSubscription · resumeBillingSubscription · billingPortal · buyAddOn · removeAddOn · setProjectRetention · createProject · renameProject · archiveProject · rotateSigningSecret · rotateProjectKey · createDashboard · updateDashboard · deleteDashboard · createDashboardFromTemplate · createInsight · updateInsight · deleteInsight · setInsightWatch · clearInsightWatch · createReport · updateReport · renameReport · describeReport · moveReport · duplicateReport · deleteReport · restoreReport · restoreReportVersion · createAnnotation · updateAnnotation · deleteAnnotation · createPropertyDefinition · updatePropertyDefinition · archivePropertyDefinition · setBuiltinPropertySensitive · createPropertyGroup · renamePropertyGroup · reorderPropertyGroups · deletePropertyGroup · saveRecord · bulkEditRecords · createAssociationLabel · renameAssociationLabel · reorderAssociationLabels · deleteAssociationLabel · labelLink · createSavedView · updateSavedView · deleteSavedView · reorderSavedViews · createCrmTask · updateCrmTask · completeCrmTask · deleteCrmTask · createCrmNote · updateCrmNote · deleteCrmNote · logCrmActivity · deleteCrmActivity · createCrmTag · updateCrmTag · deleteCrmTag · tagCrmRecord · createCrmLifecycleRule · updateCrmLifecycleRule · deleteCrmLifecycleRule · createCrmRoutingRule · updateCrmRoutingRule · deleteCrmRoutingRule · reorderCrmRoutingRules · setCrmLifecycleBackwards · startCrmImport · cancelCrmImport · startCrmExport · cancelCrmExport · createCrmScore · updateCrmScore · deleteCrmScore · rescoreCrmScore · createCrmPipeline · updateCrmPipeline · reorderCrmPipelines · deleteCrmPipelineStage · deleteCrmPipeline · setCrmReportingCurrency · createCrmDeal · updateCrmDeal · moveCrmDeal · deleteCrmDeal · associateCrmDeal · dissociateCrmDeal · makeCrmDealPrimary · dismissCrmDuplicates · mergeCrmDuplicate · refreshCrmDuplicates · setCrmAutoMerge · setCrmFormatRules · applyCrmFormatFixes · setReportPublicLink · turnOffReportPublicLink · shareReport · createReportEndpoint · revokeReportEndpoint · startReportCommentThread · replyToReportCommentThread · editReportComment · deleteReportComment · resolveReportCommentThread · reopenReportCommentThread · addReportCommentReaction · removeReportCommentReaction · createCohort · createCohortFromResult · createStaticCohort · updateCohort · setCohortActive · addCohortMembers · removeCohortMembers · deleteCohort · replyToConversation · draftConversationReply · summarizeConversation · translateConversationText · assignConversation · mapSlackInboxChannel · unmapSlackInboxChannel · sendWhatsappTemplate · ensureSupportReports · removeConversationParticipant · setMyEmailSignature · setSupportReplyFrom · dismissConversationDuplicate · setConversationStatus · flagConversation · markConversationNotSpam · setConversationPriority · setConversationAttributes · saveConversationDraft · setMyReplyUndoSeconds · holdConversationReply · undoConversationReply · mergeConversation · createMacro · updateMacro · deleteMacro · applyMacro · setInboxAssignmentMethod · setInboxMemberLimit · setMyInboxAway · createInboxView · updateInboxView · deleteInboxView · reorderInboxViews · setConversationAttributeDefinitions · markConversationRead · updateMessengerConfig · setMessengerEnabled · setMessengerTeam · updateMyMessengerProfile · updateMessengerAssistant · setMessengerAiReplyCap · addMessengerKnowledgeLink · removeMessengerKnowledgeSource · translateMessengerTexts · setMessengerArticleSearch · refreshHelpCentre · enableAi · disableAi · setAiModel · setAiLimit · checkAiAccount · connectAiAccount · removeAiAccount · removeAiLimit · deleteStoredFile · clearStoredFiles · approveProposal · rejectProposal · editProposal · proposeThreadAction · switchAccount · createAccount · renameAccount · renameCompany · mergePeople · operatorSetMemberSystemRole · operatorGrantExemption · createIntegrationConnection · addIntegrationTarget · setIntegrationTestMode · setIntegrationReach · setIntegrationProject · setIntegrationBodyTemplate · disableIntegrationConnection · revokeIntegrationConnection · startSlackInstall · completeSlackInstall · startEventConnectorInstall · completeEventConnectorInstall · cancelEventConnectorInstall · pullEventConnector · sendIntegrationTest · applyCopy · setAgentAccess · revokeAgentConnection · mintScimToken · revokeScimToken · setCompanySignInRules · closeCompany · reopenCompany · exportCompany · downloadCompanyExport · connectCompanySso · disconnectCompanySso · createWarehouseDestination · updateWarehouseDestination · deleteWarehouseDestination · backfillWarehouse · createWarehouseSource · updateWarehouseSource · addWarehouseSourceTable · removeWarehouseSourceTable · runWarehouseSource · deleteWarehouseSource · createWarehouseModel · updateWarehouseModel · runWarehouseModel · deleteWarehouseModel · translateSurveyTexts · createSurvey · updateSurvey · startSurvey · stopSurvey · archiveSurvey · duplicateSurvey · createGuide · updateGuide · startGuide · stopGuide · archiveGuide · duplicateGuide · createTicketType · updateTicketType · setTicketTypeArchived · setTicketStates · createTicket · updateTicket · addTicketNote · linkTicketToTracker · mergeTicket · createSlaPolicy · updateSlaPolicy · deleteSlaPolicy · setSlaRules · createIngestTransformation · updateIngestTransformation · moveIngestTransformation · deleteIngestTransformation · connectProjectDomain · checkProjectDomain · removeProjectDomain · createCrmForm · updateCrmForm · publishCrmForm · archiveCrmForm · deleteCrmFormSubmission · createCrmCta · updateCrmCta · publishCrmCta · pauseCrmCta · resumeCrmCta · archiveCrmCta · createCrmPage · updateCrmPage · publishCrmPage · unpublishCrmPage · archiveCrmPage · saveCrmConsentBanner · publishCrmConsentBanner · unpublishCrmConsentBanner · addEmailDomain · checkEmailDomain · setEmailDomainTracking · removeEmailDomain · requestEmailDedicatedIp · saveEmailCompanySettings · createEmailSubscriptionType · updateEmailSubscriptionType · setEmailSubscriptionTypeArchived · setPersonEmailSubscription · setPersonMarketingContact · addEmailSuppression · removeEmailSuppression · resumeEmailSending · createMarketingEmail · saveMarketingEmail · sendMarketingEmailTest · requestMarketingEmailApproval · approveMarketingEmail · rejectMarketingEmail · scheduleMarketingEmail · unscheduleMarketingEmail · pauseMarketingEmail · resumeMarketingEmail · cancelMarketingEmail · archiveMarketingEmail · saveEmailTemplate · archiveEmailTemplate · saveEmailBrandKit · saveEmailSendingSettings · createPushApp · updatePushApp · setPushAppFcm · setPushAppApns · archivePushApp · connectSms · setSmsInboxProject · disconnectSms · removeSmsOptOut · createChannelMessage · saveChannelMessage · requestChannelMessageApproval · approveChannelMessage · rejectChannelMessage · sendChannelMessageTest · scheduleChannelMessage · unscheduleChannelMessage · pauseChannelMessage · resumeChannelMessage · cancelChannelMessage · archiveChannelMessage · createCohortSync · updateCohortSync · resyncCohort · deleteCohortSync · createCohortFolder · renameCohortFolder · moveCohortFolder · deleteCohortFolder · moveCohortToFolder · drawCohort · createLookalikeCohort · cancelLookalikeCohort · createEventStream · updateEventStream · deleteEventStream · testEventStream · erasePerson · downloadEndUserExport · exportPerson · startSideConversation · replySideConversation · setSideConversationStatus · createMarketingCampaign · updateMarketingCampaign · archiveMarketingCampaign · restoreMarketingCampaign · addMarketingCampaignAsset · removeMarketingCampaignAsset · addMarketingCampaignSpend · updateMarketingCampaignSpend · deleteMarketingCampaignSpend · createMarketingTrackingUrl · updateMarketingTrackingUrl · deleteMarketingTrackingUrl · createMarketingCampaignView · updateMarketingCampaignView · deleteMarketingCampaignView · createMarketingEvent · updateMarketingEvent · cancelMarketingEvent · restoreMarketingEvent · deleteMarketingEvent · recordMarketingEventRegistration · recordMarketingEventAttendance · recordMarketingEventCancellation
SubscriptionflagChanges · flagRolloutChanges · flagChangeRequestChanges · messageEvents · workflowRunChanges · eventsIngested · conversationTurns · conversationChanges · aiProposals · grantsChanged · annotationChanges · crmChanges · cohortChanges · projectDomainChanges · addOnsChanges · crmFormChanges · crmCtaChanges · marketingCampaignChanges · marketingEventChanges · crmPageChanges · crmConsentBannerChanges · emailChanges · marketingEmailChanges · channelMessageChanges · reportShareChanges · reportCommentChanges

A query

GraphQL
query Projects {
  projects {
    id
    slug
    name
    environment
  }
}

A mutation

GraphQL
mutation ArchiveFlag($projectId: String!, $key: String!) {
  archiveFlag(projectId: $projectId, key: $key) {
    key
    archived
  }
}

Subscriptions

Subscribe over WebSocket at wss://api.prodantix.com/graphql/ws

GraphQL
subscription FlagChanges($projectId: String!) {
  flagChanges(projectId: $projectId) {
    key
    enabled
  }
}
JSON
{
  "type": "connection_init",
  "payload": { "Authorization": "Bearer <access token>" }
}