Sanggunian ng GraphQL
Bawat field na inihahain ng schema, buhat mismo sa server: mga query, mutation at subscription kasama ang kanilang mga argumento at return type. Muling binubuo ng CI ang listahang ito sa bawat pagbabago ng schema.
Queries (69)
| Field | Arguments | Returns |
|---|---|---|
| ping | String! | |
| me | Me! | |
| flags | projectId: String! | [FlagDto!]! |
| archivedFlags | projectId: String! | [FlagDto!]! |
| experiments | projectId: String! | [ExperimentDto!]! |
| experiment | projectId: String!, key: String! | ExperimentDto |
| experimentResults | projectId: String!, key: String! | ExperimentResultsDto! |
| flagHistory | projectId: String!, key: String!, limit: Int!, before: String | [FlagVersionDto!]! |
| flagRollouts | projectId: String!, key: String | [FlagRolloutDto!]! |
| flagChangeRequests | projectId: String!, status: String | [FlagChangeRequestDto!]! |
| flagChangeRequest | projectId: String!, id: String! | FlagChangeRequestDto |
| flagReviewRequired | projectId: String! | Boolean! |
| promotionDiff | fromProjectId: String!, toProjectId: String!, key: String! | FlagPromotionDto! |
| workflowDefinitions | projectId: String! | [WorkflowDefinitionDto!]! |
| workflowDefinitionStats | projectId: String! | [WorkflowDefinitionStatsDto!]! |
| workflowDefinition | projectId: String!, definitionId: String! | WorkflowDefinitionDto! |
| workflowRuns | projectId: String!, definitionId: String, status: String, limit: Int!, before: String, beforeRunId: String | [WorkflowRunDto!]! |
| workflowRunsPage | projectId: String!, definitionId: String!, status: String, query: String, offset: Int!, limit: Int! | WorkflowRunsPageDto! |
| workflowRunSteps | projectId: String!, runId: String! | [WorkflowRunStepDto!]! |
| workflowVersionGraph | projectId: String!, versionId: String! | String! |
| workflowRun | projectId: String!, runId: String! | WorkflowRunDto! |
| health | String! | |
| runQuery | projectId: String!, query: MetricsQueryInput! | QueryResult! |
| runFunnel | projectId: String!, query: JSON! | [FunnelStepDto!]! |
| runRetention | projectId: String!, query: JSON! | [RetentionRowDto!]! |
| runPaths | projectId: String!, query: JSON! | [PathStepDto!]! |
| runStickiness | projectId: String!, query: JSON! | [StickinessPeriodDto!]! |
| runLifecycle | projectId: String!, query: JSON! | [LifecyclePeriodDto!]! |
| aiTranslateQuery | projectId: String!, question: String! | String! |
| aiAnswer | projectId: String!, question: String!, query: String! | String! |
| aiInsights | projectId: String!, event: String!, from: String!, to: String!, threshold: Float! | [AiInsight!]! |
| projects | [Project!]! | |
| projectGroups | includeArchived: Boolean | [ProjectGroup!]! |
| projectAllowance | ProjectAllowance! | |
| replaySessions | projectId: String! | [ReplaySessionDto!]! |
| replayChunks | projectId: String!, sessionId: String! | [ReplayChunkDto!]! |
| events | projectId: String!, filter: EventFilterInput, limit: Int, cursor: String | EventPage! |
| eventCatalog | projectId: String! | EventCatalog! |
| messages | projectId: String! | [Message!]! |
| billingState | BillingStateDto! | |
| tierLimits | [TierLimitDto!]! | |
| billingPlanChangePreview | plan: BillingPlanInput! | BillingProrationPreview! |
| dashboards | projectId: String! | [DashboardDto!]! |
| cohorts | projectId: String! | [CohortDto!]! |
| cohort | projectId: String!, cohortId: String! | CohortDto |
| cohortMembers | projectId: String!, cohortId: String!, limit: Int, offset: Int | [CohortMemberDto!]! |
| cohortMemberCount | projectId: String!, cohortId: String! | Int! |
| projectPeople | projectId: String!, search: String, status: String, groupKey: String, cursor: String, limit: Int | PersonPageDto! |
| projectPeopleGroups | projectId: String!, search: String, groupType: String | [PeopleGroupDto!]! |
| projectPerson | projectId: String!, distinctId: String! | PersonDetailDto |
| organisationMembers | [OrganisationMember!]! | |
| pendingInvitations | [PendingInvitation!]! | |
| organisationRoles | [OrganisationRole!]! | |
| assignableRoles | [HeldRole!]! | |
| operatorTenants | limit: Int! | [OperatorTenantDto!]! |
| operatorUsage | limit: Int! | [OperatorUsageDto!]! |
| operatorSubscriptions | limit: Int! | [OperatorSubscriptionDto!]! |
| operatorVolumeChanges | limit: Int! | [OperatorVolumeChangeDto!]! |
| operatorTenantDetail | tenantId: String! | OperatorTenantDetailDto |
| conversations | projectId: String!, status: String, assignedToMe: Boolean, cursorLastTurnAt: String, cursorId: String, limit: Int | [AgentConversation!]! |
| projectAutosend | projectId: String! | Boolean! |
| conversation | projectId: String!, id: String! | ConversationThread |
| messengerConfig | projectId: String! | MessengerConfig! |
| aiProposals | projectId: String!, statuses: [String!] | [AiProposalGql!]! |
| myAccounts | MyAccounts! | |
| myGrants | scopeId: String | [String!]! |
| integrationProviders | [IntegrationProviderDto!]! | |
| integrationConnections | projectId: String! | [IntegrationConnectionDto!]! |
| slackChannels | connectionId: String! | [SlackChannelDto!]! |
Mutations (74)
| Field | Arguments | Returns |
|---|---|---|
| upsertFlag | projectId: String!, flag: FlagInput! | FlagDto! |
| archiveFlag | projectId: String!, key: String! | Boolean! |
| restoreFlag | projectId: String!, key: String! | Boolean! |
| createExperiment | projectId: String!, input: ExperimentInput! | ExperimentDto! |
| updateExperiment | projectId: String!, key: String!, input: ExperimentInput! | ExperimentDto! |
| startExperiment | projectId: String!, key: String! | ExperimentDto! |
| stopExperiment | projectId: String!, key: String! | ExperimentDto! |
| concludeExperiment | projectId: String!, key: String!, winner: String, conclusion: String, ship: Boolean! | ExperimentDto! |
| deleteExperiment | projectId: String!, key: String! | Boolean! |
| startFlagRollout | projectId: String!, key: String!, rollout: String! | FlagRolloutDto! |
| cancelFlagRollout | projectId: String!, id: String! | FlagRolloutDto! |
| rollbackFlagRollout | projectId: String!, id: String! | FlagRolloutDto! |
| setFlagReviewRequired | projectId: String!, required: Boolean! | Boolean! |
| proposeFlagChange | projectId: String!, change: String!, key: String, comment: String | FlagChangeRequestDto! |
| approveFlagChange | projectId: String!, id: String!, comment: String | FlagChangeRequestDto! |
| rejectFlagChange | projectId: String!, id: String!, comment: String | FlagChangeRequestDto! |
| withdrawFlagChange | projectId: String!, id: String! | FlagChangeRequestDto! |
| promoteFlag | fromProjectId: String!, toProjectId: String!, key: String! | FlagPromotionDto! |
| createWorkflowDefinition | projectId: String!, name: String!, draft: WorkflowDraftInput! | WorkflowDefinitionDto! |
| updateWorkflowDefinition | projectId: String!, definitionId: String!, draft: WorkflowDraftInput! | Boolean! |
| saveCanvasLayout | projectId: String!, definitionId: String!, layout: String! | Boolean! |
| setWorkflowEnabled | projectId: String!, definitionId: String!, enabled: Boolean! | Boolean! |
| deleteWorkflowDefinition | projectId: String!, definitionId: String! | Boolean! |
| publishWorkflowVersion | projectId: String!, definitionId: String! | String! |
| fireWorkflow | projectId: String!, definitionId: String!, input: String | FireWorkflowResult! |
| signalWorkflow | projectId: String!, runId: String!, signalName: String!, payload: String | Boolean! |
| cancelWorkflow | projectId: String!, runId: String! | Boolean! |
| registerDeviceToken | token: String!, platform: String!, webKeys: String | DeviceTokenMutationResult! |
| unregisterDeviceToken | token: String! | DeviceTokenMutationResult! |
| requestAccountDeletion | AccountDeletionResult! | |
| cancelAccountDeletion | AccountDeletionMutationOk! | |
| composeMessage | projectId: String!, input: ComposeMessageInput! | ComposeMessageResult! |
| startBillingCheckout | plan: BillingPlanInput! | BillingCheckoutResult! |
| changeBillingPlan | plan: BillingPlanInput! | BillingMutationOk! |
| cancelBillingSubscription | BillingMutationOk! | |
| resumeBillingSubscription | BillingMutationOk! | |
| billingPortal | BillingPortalResult! | |
| createProject | slug: String!, name: String! | CreatedProject! |
| renameProject | slug: String!, name: String! | ProjectGroup! |
| archiveProject | slug: String! | ProjectGroup! |
| rotateSigningSecret | projectId: String! | RotatedSigningSecret! |
| rotateProjectKey | projectId: String!, graceHours: Int | RotatedProjectKey! |
| createDashboard | projectId: String!, name: String!, tiles: [DashboardTileInput!]! | DashboardDto! |
| updateDashboard | projectId: String!, dashboardId: String!, name: String, tiles: [DashboardTileInput!] | DashboardDto! |
| deleteDashboard | projectId: String!, dashboardId: String! | Boolean! |
| createCohort | projectId: String!, name: String!, definition: JSON! | CohortDto! |
| updateCohort | projectId: String!, cohortId: String!, name: String, definition: JSON | CohortDto! |
| setCohortActive | projectId: String!, cohortId: String!, isActive: Boolean! | CohortDto! |
| deleteCohort | projectId: String!, cohortId: String! | Boolean! |
| replyToConversation | projectId: String!, conversationId: String!, body: String! | AgentTurn! |
| draftConversationReply | projectId: String!, conversationId: String! | String! |
| setProjectAutosend | projectId: String!, enabled: Boolean! | Boolean! |
| assignConversation | projectId: String!, conversationId: String!, toMe: Boolean! | AgentConversation! |
| setConversationStatus | projectId: String!, conversationId: String!, status: String!, snoozedUntil: String | AgentConversation! |
| updateMessengerConfig | projectId: String!, input: MessengerConfigInput! | MessengerConfig! |
| approveProposal | id: String! | Boolean! |
| rejectProposal | id: String! | Boolean! |
| editProposal | id: String!, proposal: String! | AiProposalGql! |
| proposeThreadAction | projectId: String!, conversationId: String! | AiProposalGql! |
| switchAccount | accountNo: Int! | MyAccounts! |
| createAccount | label: String | MyAccount! |
| renameAccount | accountNo: Int!, label: String | MyAccount! |
| mergePeople | projectId: String!, fromDistinctId: String!, toDistinctId: String! | MergeResultDto! |
| createIntegrationConnection | input: CreateIntegrationConnectionInput! | String! |
| addIntegrationTarget | input: AddIntegrationTargetInput! | String! |
| setIntegrationTestMode | connectionId: String!, testMode: String! | Boolean! |
| setIntegrationReach | connectionId: String!, reach: String! | Boolean! |
| setIntegrationProject | connectionId: String!, projectId: String!, enabled: Boolean! | Boolean! |
| setIntegrationBodyTemplate | connectionId: String!, bodyTemplate: String | Boolean! |
| disableIntegrationConnection | connectionId: String!, disabled: Boolean! | Boolean! |
| revokeIntegrationConnection | connectionId: String! | Boolean! |
| startSlackInstall | connectionId: String! | String! |
| completeSlackInstall | code: String!, state: String! | Boolean! |
| sendIntegrationTest | projectId: String!, connectionId: String!, targetId: String, channel: TestChannelInput, emailTo: String | IntegrationTestReport! |
Subscriptions (9)
| Field | Arguments | Returns |
|---|---|---|
| flagChanges | projectId: String! | FlagChange! |
| flagRolloutChanges | projectId: String! | FlagRolloutChange! |
| flagChangeRequestChanges | projectId: String! | FlagChangeRequestChange! |
| messageEvents | projectId: String! | MessageEvent! |
| workflowRunChanges | projectId: String! | WorkflowRunChange! |
| eventsIngested | projectId: String! | IngestedEvent! |
| conversationTurns | projectId: String! | ConversationTurnEvent! |
| aiProposals | projectId: String! | AiProposalGql! |
| grantsChanged | Boolean! |