About the GraphQL API

About GraphQL

The GraphQL data query language is:

  • A specification. The spec determines the validity of the schema on the API server. The schema determines the validity of client calls.

  • Strongly typed. The schema defines an API's type system and all object relationships.

  • Introspective. A client can query the schema for details about the schema.

  • Hierarchical. The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query for and receive only the data you specify in a single round trip.

  • An application layer. GraphQL is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored.

Queries

In this section

About queries

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

Arguments

Name Description

id (ID!)


Arguments

Name Description

id (Float)

createdAt (DateTime)

createdAtGte (DateTime)

createdAtLte (DateTime)

modifiedAt (DateTime)

modifiedAtGte (DateTime)

modifiedAtLte (DateTime)

createdBy ([ID!])

modifiedBy ([ID!])

search (String)

isCurrentUserMember (Boolean)

recentlyUsed (Boolean)

tags ([ID!])

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

id (Float)

search (String)

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

label (String)

parent (ID)

subPillar (AssessmentRegistrySummarySubPillarTypeEnum)

subDimension (AssessmentRegistrySummarySubDimensionTypeEnum)

search (String)

isParent (Boolean)

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

url (String)


Arguments

Name Description

filter (ExploreDeepFilterInputType!)


Arguments

Name Description

id (ID!)


me

Type: UserMeType


Arguments

Name Description

id (ID!)


Arguments

Name Description

timestamp (DateTime)

timestampLte (DateTime)

timestampGte (DateTime)

isPending (Boolean)

notificationType (NotificationTypeEnum)

status (NotificationStatusEnum)

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

id (Float)

verified (Boolean)

search (String)

usedInProjectByLead (ID)

usedInProjectByAssesment (ID)

ordering ([OrganizationOrderingEnum!])

page (Int)

pageSize (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

title (String)

shortName (String)

description (String)

reliefWebId (Int)

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

createdAt (DateTime)

createdAtGte (DateTime)

createdAtLte (DateTime)

modifiedAt (DateTime)

modifiedAtGte (DateTime)

modifiedAtLte (DateTime)

createdBy ([ID!])

modifiedBy ([ID!])

ids ([ID!])

excludeIds ([ID!])

status (ProjectStatusEnum)

organizations ([ID!])

analysisFrameworks ([ID!])

regions ([ID!])

search (String)

isCurrentUserMember (Boolean)

hasPermissionAccess (ProjectPermission)

ordering ([ProjectOrderingEnum!])

isTest (Boolean)

page (Int)

pageSize (Int)


Arguments

Name Description

projectFilter (RegionProjectFilterData)

ordering (String)


Arguments

Name Description

id (Float)

createdAt (DateTime)

createdAtGte (DateTime)

createdAtLte (DateTime)

modifiedAt (DateTime)

modifiedAtGte (DateTime)

modifiedAtLte (DateTime)

createdBy ([ID!])

modifiedBy ([ID!])

search (String)

isCurrentUserMember (Boolean)

recentlyUsed (Boolean)

tags ([ID!])

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

slug (String!)


Arguments

Name Description

uuid (UUID!)


Arguments

Name Description

id (Float)

verified (Boolean)

search (String)

usedInProjectByLead (ID)

usedInProjectByAssesment (ID)

ordering ([OrganizationOrderingEnum!])

page (Int)

pageSize (Int)


Arguments

Name Description

createdAt (DateTime)

createdAtGte (DateTime)

createdAtLte (DateTime)

modifiedAt (DateTime)

modifiedAtGte (DateTime)

modifiedAtLte (DateTime)

createdBy ([ID!])

modifiedBy ([ID!])

ids ([ID!])

excludeIds ([ID!])

status (ProjectStatusEnum)

organizations ([ID!])

analysisFrameworks ([ID!])

regions ([ID!])

search (String)

isCurrentUserMember (Boolean)

hasPermissionAccess (ProjectPermission)

ordering ([PublicProjectOrderingEnum!])

isTest (Boolean)

page (Int)

pageSize (Int)


Arguments

Name Description

projectFilter (RegionProjectFilterData)

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

id (Float)

code (String)

title (String)

public (Boolean)

project ([ID])

createdAt (DateTime)

createdBy ([ID])

modifiedAt (DateTime)

modifiedBy ([ID])

createdAt_Lt (Date)

createdAt_Gte (Date)

modifiedAt_Lt (Date)

modifiedAt_Gt (Date)

excludeProject ([ID!])

search (String)

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

url (String)


user

Type: UserType

Arguments

Name Description

id (ID!)


Arguments

Name Description

id (ID!)


Arguments

Name Description

isCurrentUserMember (Boolean)

search (String)

membersIncludeProject (ID)

membersExcludeProject (ID)

page (Int)

ordering (String)

pageSize (Int)


Arguments

Name Description

id (Float)

search (String)

membersExcludeProject (ID)

membersExcludeFramework (ID)

membersExcludeUsergroup (ID)

page (Int)

ordering (String)

pageSize (Int)


Mutations

In this section

About mutations

Every GraphQL schema has a root type for both queries and mutations. The mutation type defines GraphQL operations that change data on the server. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE.

Arguments

Name Description

id (ID!)

Return fields

Name Description

id (ID!)

title (String!)

analysisFrameworkUpdate (UpdateAnalysisFramework)

analysisFrameworkMembershipBulk (BulkUpdateAnalysisFrameworkMembership)


Arguments

Name Description

data (AnalysisFrameworkInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (AnalysisFrameworkDetailType)


Arguments

Name Description

data (PasswordChangeInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)


Arguments

Name Description

data (ProjectPinnedInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (UserPinnedProjectType)


Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (UserMeType)


Arguments

Name Description

id (ID!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (UserPinnedProjectType)


Arguments

Name Description

data (FileUploadInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (GalleryFileType)


Arguments

Name Description

id (ID!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (UserGenericExportType)


Arguments

Name Description

data (GenericExportCreateInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (UserGenericExportType)


Arguments

Name Description

data (ProjectJoinRequestInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (ProjectJoinRequestType)


login

Type: Login

Arguments

Name Description

data (LoginInputType!)

Return fields

Name Description

result (UserMeType)

errors ([GenericScalar!])

ok (Boolean!)

captchaRequired (Boolean!)


Arguments

Name Description

data (HIDLoginInputType!)

Return fields

Name Description

result (UserMeType)

errors ([GenericScalar!])

ok (Boolean!)


logout

Type: Logout

Return fields

Name Description

ok (Boolean)


Arguments

Name Description

data (NotificationStatusInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (NotificationType)


Arguments

Name Description

id (ID!)

Return fields

Name Description

id (ID!)

title (String!)

createAssessmentRegistry (CreateAssessmentRegistry)

updateAssessmentRegistry (UpdateAssessmentRegistry)

deleteAssessmentRegistry (DeleteAssessmentRegistry)

analysisPillarUpdate (UpdateAnalysisPillar)

discardedEntryCreate (CreateAnalysisPillarDiscardedEntry)

discardedEntryUpdate (UpdateAnalysisPillarDiscardedEntry)

discardedEntryDelete (DeleteAnalysisPillarDiscardedEntry)

triggerAnalysisTopicModel (TriggerAnalysisTopicModel)

triggerAnalysisAutomaticSummary (TriggerAnalysisAutomaticSummary)

triggerAnalysisAutomaticNgram (TriggerAnalysisAnalyticalStatementNGram)

triggerAnalysisGeoLocation (TriggerAnalysisAnalyticalGeoTask)

analysisReportCreate (CreateAnalysisReport)

analysisReportUpdate (UpdateAnalysisReport)

analysisReportDelete (DeleteAnalysisReport)

analysisReportSnapshotCreate (CreateAnalysisReportSnapshot)

analysisReportUploadCreate (CreateAnalysisReportUpload)

analysisReportUploadDelete (DeleteAnalysisReportUpload)

exportCreate (CreateUserExport)

exportUpdate (UpdateUserExport)

exportCancel (CancelUserExport)

exportDelete (DeleteUserExport)

assessmentDelete (DeleteAssessment)

entryReviewCommentCreate (CreateEntryReviewComment)

entryReviewCommentUpdate (UpdateEntryReviewComment)

entryReviewCommentDelete (DeleteEntryReviewComment)

entryCreate (CreateEntry)

entryUpdate (UpdateEntry)

entryDelete (DeleteEntry)

entryBulk (BulkEntry)

leadCreate (CreateLead)

leadUpdate (UpdateLead)

leadDelete (DeleteLead)

leadBulk (BulkLead)

leadGroupDelete (DeleteLeadGroup)

leadCopy (LeadCopy)

leadFilterSave (SaveUserSavedLeadFilter)

projectUpdate (UpdateProject)

projectDelete (ProjectDelete)

acceptRejectProject (ProjectAcceptReject)

projectUserMembershipBulk (BulkUpdateProjectMembership)

projectUserGroupMembershipBulk (BulkUpdateProjectUserGroupMembership)

projectRegionBulk (BulkUpdateProjectRegion)

projectVizConfigurationUpdate (UpdateProjectVizConfiguration)

unifiedConnector (UnifiedConnectorMutationType)

assistedTagging (AssistedTaggingMutationType)


Arguments

Name Description

data (ProjectCreateInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (ProjectDetailType)


Arguments

Name Description

projectId (ID!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (ProjectJoinRequestType)


Arguments

Name Description

data (RegisterInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean!)

captchaRequired (Boolean!)


Arguments

Name Description

items ([UserPinnedProjectReOrderInputType!])

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result ([UserPinnedProjectType])


Arguments

Name Description

data (ResetPasswordInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean!)

captchaRequired (Boolean!)


Arguments

Name Description

data (UserMeInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (UserMeType)


Arguments

Name Description

id (ID!)

Return fields

Name Description

id (ID!)

title (String!)

userGroupUpdate (UpdateUserGroup)

userGroupDelete (DeleteUserGroup)

userGroupMembershipBulk (BulkUpdateUserGroupMembership)


Arguments

Name Description

data (UserGroupInputType!)

Return fields

Name Description

errors ([GenericScalar!])

ok (Boolean)

result (UserGroupType)


Objects

In this section

About objects

Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.

Fields

Name Description

id (ID!)

file (GalleryFileType)

clientId (ID!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

documentType (AssessmentRegistryDocumentTypeEnum!)

documentTypeDisplay (EnumDescription!)

externalLink (String)


Fields

Name Description

id (ID!)

title (String!)

level (Int)

nameProp (String!)

codeProp (String!)

parentNameProp (String!)

parentCodeProp (String!)

geoShapeFile (GalleryFileType)

tolerance (Float!)

staleGeoAreas (Boolean!)

parent (ID)

geojsonFile (FileFieldType)

boundsFile (FileFieldType)


Fields

Name Description

id (ID!)

summary (String!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

status (AutomaticSummaryStatusEnum!)


Fields

Name Description

id (ID!)

title (String!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

description (String)

isPrivate (Boolean!)

assistedTaggingEnabled (Boolean!)

organization (OrganizationType)

currentUserRole (AnalysisFrameworkRoleTypeEnum)

previewImage (FileFieldType)

export (FileFieldType)

clonedFrom (ID)

allowedPermissions ([AnalysisFrameworkPermission!]!)

tags ([AnalysisFrameworkTagType!]!)

usedInProjectCount (AnalysisFrameworkProjectCount!)

primaryTagging ([SectionType!])

secondaryTagging ([WidgetType!])

members ([AnalysisFrameworkMembershipType!])

filters ([AnalysisFrameworkFilterType!])

exportables ([AnalysisFrameworkExportableType!])

visibleProjects ([AnalysisFrameworkVisibleProjectType!])

predictionTagsMapping ([AnalysisFrameworkPredictionMappingType!])

properties (AnalysisFrameworkPropertiesType)


Fields

Name Description

id (ID!)

inline (Boolean!)

order (Int!)

data (GenericScalar)

widgetKey (String!)

widgetType (WidgetWidgetTypeEnum!)

widgetTypeDisplay (EnumDescription!)


Fields

Name Description

id (ID!)

widgetKey (String!)

title (String!)

properties (GenericScalar)

key (String!)

widgetType (WidgetWidgetTypeEnum!)

widgetTypeDisplay (EnumDescription!)

filterType (WidgetFilterTypeEnum!)

filterTypeDisplay (EnumDescription!)


Fields

Name Description

results ([AnalysisFrameworkType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

id (ID!)

member (UserType!)

role (AnalysisFrameworkRoleType!)

joinedAt (DateTime!)

addedBy (UserType)

clientId (ID!)


Fields

Name Description

id (ID!)

title (String!)

analysisFrameworkUpdate (UpdateAnalysisFramework)

analysisFrameworkMembershipBulk (BulkUpdateAnalysisFrameworkMembership)


Fields

Name Description

id (ID!)

widget (ID!)

tag (ID)

association (GenericScalar)

clientId (ID!)

widgetType (WidgetWidgetTypeEnum!)


Fields

Name Description

projectCount (Int!)

testProjectCount (Int!)


Fields

Name Description

pk (ID!)


Fields

Name Description

id (ID!)

title (String!)


Fields

Name Description

results ([AnalysisFrameworkTagType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

id (ID!)

title (String!)

description (String!)

icon (FileFieldType)


Fields

Name Description

id (ID!)

title (String!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

description (String)

isPrivate (Boolean!)

assistedTaggingEnabled (Boolean!)

organization (OrganizationType)

currentUserRole (AnalysisFrameworkRoleTypeEnum)

previewImage (FileFieldType)

export (FileFieldType)

clonedFrom (ID)

allowedPermissions ([AnalysisFrameworkPermission!]!)

tags ([AnalysisFrameworkTagType!]!)

usedInProjectCount (AnalysisFrameworkProjectCount!)


Fields

Name Description

id (ID!)

title (String!)

isPrivate (Boolean!)


Fields

Name Description

results ([AnalysisType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

id (ID!)

title (String!)

count (Int!)


Fields

Name Description

totalEntriesCount (Int!)

totalLeadsCount (Int!)

analyzedEntriesCount (Int!)

analyzedLeadsCount (Int!)

authoringOrganizations ([AnalysisOverviewOrganizationType!])


Fields

Name Description

results ([AnalysisPillarDiscardedEntryType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

id (ID!)

analysisPillar (ID)

entry (EntryType!)

entryId (ID!)

tag (DiscardedEntryTagTypeEnum!)

tagDisplay (EnumDescription!)


Fields

Name Description

results ([EntryType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

results ([AnalysisPillarType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

id (ID!)

title (String!)

mainStatement (String!)

informationGap (String!)

filters (GenericScalar)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

clientId (ID!)

assignee (UserType!)

analysis (ID!)

clonedFrom (ID)

analyzedEntriesCount (Int!)

statements ([AnalyticalStatementType!])

discardedEntries (AnalysisPillarDiscardedEntryListType)

entries (AnalysisPillarEntryListType)


Fields

Name Description

startDate (Date!)

endDate (Date!)


Fields

Name Description

color (String)

opacity (Int)


Fields

Name Description

sheet (String)

type (AnalysisReportBarChartTypeEnum!)

direction (AnalysisReportBarChartDirectionEnum!)

horizontalAxis (AnalysisReportHorizontalAxisType!)

verticalAxis ([AnalysisReportVerticalAxisType!]!)

horizontalAxisTitle (String)

verticalAxisTitle (String)

title (String)

subTitle (String)

legendHeading (String)

horizontalTickLabelRotation (Int)

horizontalAxisLineVisible (Boolean)

verticalAxisLineVisible (Boolean)

verticalAxisExtendMinimumValue (Int)

verticalAxisExtendMaximumValue (Int)

verticalGridLineVisible (Boolean)

horizontalGridLineVisible (Boolean)

verticalTickVisible (Boolean)

horizontalTickVisible (Boolean)

style (AnalysisReportBarChartStyleType)


Fields

Name Description

gap (Int)


Fields

Name Description

color (String)

width (Int)

opacity (Int)

style (AnalysisReportBorderStyleStyleEnum)


Fields

Name Description

id (ID!)

upload (AnalysisReportUploadType!)

clientReferenceId (String!)

data (GenericScalar!)

clientId (ID!)


Fields

Name Description

id (ID!)

row (Int!)

column (Int!)

width (Int!)

height (Int)

clientId (ID!)

contentType (AnalysisReportContainerContentTypeEnum!)

report (ID!)

style (AnalysisReportContainerStyleType)

contentConfiguration (AnalysisReportContainerContentConfigurationType)

contentData ([AnalysisReportContainerDataType!]!)


Fields

Name Description

lineColor (String)

lineWidth (Int)

lineOpacity (Int)


Fields

Name Description

contentReferenceId (String!)

weightPropertyKey (String!)

fillPalette (String)

radius (Float)

blur (Float)

scaleDataMax (Int)

weighted (Boolean)


Fields

Name Description

caption (String)

altText (String)

style (AnalysisReportImageContentStyleType)


Fields

Name Description

items ([AnalysisReportKpiItemConfigurationType!]!)

titleContentStyle (AnalysisReportTextStyleType)

subtitleContentStyle (AnalysisReportTextStyleType)

sourceContentStyle (AnalysisReportTextStyleType)

valueContentStyle (AnalysisReportTextStyleType)


Fields

Name Description

title (String)

subtitle (String)

source (String)

sourceUrl (String)

color (String)

date (Date)

value (Int)

clientId (String)

abbreviateValue (Boolean)

style (AnalysisReportKpiItemStyleConfigurationType)


Fields

Name Description

titleContentStyle (AnalysisReportTextStyleType)

subtitleContentStyle (AnalysisReportTextStyleType)

sourceContentStyle (AnalysisReportTextStyleType)

valueContentStyle (AnalysisReportTextStyleType)


Fields

Name Description

sheet (String)

horizontalAxis (AnalysisReportLineHorizontalAxisType!)

verticalAxis ([AnalysisReportVerticalAxisType!]!)

horizontalAxisTitle (String)

verticalAxisTitle (String)

title (String)

subTitle (String)

legendHeading (String)

horizontalTickLabelRotation (Int)

horizontalAxisLineVisible (Boolean)

verticalAxisLineVisible (Boolean)

verticalAxisExtendMinimumValue (Int)

verticalAxisExtendMaximumValue (Int)

verticalGridLineVisible (Boolean)

horizontalGridLineVisible (Boolean)

verticalTickVisible (Boolean)

horizontalTickVisible (Boolean)

style (AnalysisReportLineChartStyleType)


Fields

Name Description

field (String)


Fields

Name Description

dashSpacing (Int)

stroke (String)

strokeType (AnalysisReportLineLayerStrokeTypeEnum)

strokeWidth (Int)


Fields

Name Description

results ([AnalysisReportType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

title (String)

subTitle (String)

minZoom (Int)

maxZoom (Int)

zoom (Int)

showScale (Boolean)

mapHeight (Int)

scaleBar (Boolean)

enableZoomControls (Boolean)

centerLongitude (Float)

centerLatitude (Float)

layers ([AnalysisReportMapLayerConfigurationType!]!)

style (AnalysisReportMapStyleConfigType)


Fields

Name Description

clientId (String!)

name (String!)

visible (Boolean!)

order (Int!)

opacity (Int)

type (AnalysisReportMapLayerTypeEnum)

layerConfig (AnalysisReportLayerConfigType)


Fields

Name Description

mapboxStyle (String)

accessToken (String)


Fields

Name Description

top (Int)

bottom (Int)

left (Int)

right (Int)


Fields

Name Description

top (Int)

bottom (Int)

left (Int)

right (Int)


Fields

Name Description

contentReferenceId (String!)

labelColumn (String!)


Fields

Name Description

results ([AnalysisReportSnapshotType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

id (ID!)

publishedOn (DateTime!)

report (ID!)

publishedBy (UserType!)

reportDataFile (FileFieldType)

files ([GalleryFileType!]!)


Fields

Name Description

contentReferenceId (String!)

labelPropertyKey (String!)

scale (Int)

scaleType (AnalysisReportScaleTypeEnum)

scalingTechnique (AnalysisReportScalingTechniqueEnum)

showLabels (Boolean)

symbol (String!)

style (AnalysisReportSymbolLayerStyleConfigurationType)


Fields

Name Description

color (String)

family (String)

size (Int)

weight (Int)

align (AnalysisReportTextStyleAlignEnum)


Fields

Name Description

lineColor (String)

lineWidth (Int)

lineOpacity (Int)


Fields

Name Description

sheet (String)

date (String!)

title (String!)

detail (String)

category (String)

source (String)

sourceUrl (String)


Fields

Name Description

id (ID!)

isPublic (Boolean!)

slug (String!)

title (String!)

subTitle (String!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

analysis (ID!)

configuration (AnalysisReportConfigurationType)

containers ([AnalysisReportContainerType!]!)

organizations ([OrganizationType!]!)

uploads ([AnalysisReportUploadType!]!)

latestSnapshot (AnalysisReportSnapshotType)


Fields

Name Description

results ([AnalysisReportUploadType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

headerRow (Int)

variables ([AnalysisReportVariableType!]!)


Fields

Name Description

name (String)

headerRow (Int)

clientId (String)

variables ([AnalysisReportVariableType!]!)


Fields

Name Description

url (String)


Fields

Name Description

name (String)

clientId (String)

type (AnalysisReportVariableTypeEnum)

completeness (Int)


Fields

Name Description

clientId (String)

label (String)

field (String)

aggregationType (AnalysisReportAggregationTypeEnum)

color (String)


Fields

Name Description

id (ID!)

title (String)

entries ([EntryType]!)


Fields

Name Description

id (ID!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

status (TopicModelStatusEnum!)

clusters ([AnalysisTopicModelClusterType]!)

additionalFilters (EntriesFilterDataType)

analysisPillar (ID!)


Fields

Name Description

id (ID!)

title (String!)

startDate (Date)

endDate (Date!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

clonedFrom (ID)

teamLead (UserType!)

publicationDate (AnalysisPublicationDateType)

analyzedEntriesCount (Int!)

analyzedLeadsCount (Int!)

pillars ([AnalysisPillarType!])


Fields

Name Description

latitude (Float)

longitude (Float)

offsetStart (Int)

offsetEnd (Int)


Fields

Name Description

id (ID!)

entry (EntryType!)

entryId (ID!)

data ([AnalyticalStatementEntryGeoDataType!])


Fields

Name Description

id (ID!)

order (Int!)

clientId (ID!)

entry (EntryType!)

entryId (ID!)

analyticalStatement (ID!)


Fields

Name Description

id (ID!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

status (AnalyticalStatementGeoTaskStatusEnum!)

entryGeo ([AnalyticalStatementEntryGeoType]!)


Fields

Name Description

results ([AnalyticalStatementType!])

totalCount (Int)

page (Int)

pageSize (Int)


Fields

Name Description

word (String!)

count (Int!)


Fields

Name Description

id (ID!)

statement (String!)

title (String)

includeInReport (Boolean!)

order (Int!)

reportText (String!)

informationGaps (String!)

clientId (ID!)

createdAt (DateTime!)

modifiedAt (DateTime!)

createdBy (UserType)

modifiedBy (UserType)

clonedFrom (ID)

entriesCount (Int!)

entries ([AnalyticalStatementEntryType!])


Fields

Name Description

ProfileEmailOptOuts ([AppEnumCollectionProfileEmailOptOuts!])

UserEmailOptOuts ([AppEnumCollectionUserEmailOptOuts!])

GroupMembershipRole ([AppEnumCollectionGroupMembershipRole!])

ProjectStatus ([AppEnumCollectionProjectStatus!])

ProjectOrganizationOrganizationType ([AppEnumCollectionProjectOrganizationOrganizationType!])

ProjectJoinRequestStatus ([AppEnumCollectionProjectJoinRequestStatus!])

ProjectStatsStatus ([AppEnumCollectionProjectStatsStatus!])

ProjectMembershipBadges ([AppEnumCollectionProjectMembershipBadges!])

ProjectUserGroupMembershipBadges ([AppEnumCollectionProjectUserGroupMembershipBadges!])

ProjectRoleType ([AppEnumCollectionProjectRoleType!])

ProjectStatsAction ([AppEnumCollectionProjectStatsAction!])

WidgetWidgetId ([AppEnumCollectionWidgetWidgetId!])

WidgetWidth ([AppEnumCollectionWidgetWidth!])

FilterFilterType ([AppEnumCollectionFilterFilterType!])

AnalysisFrameworkRoleType ([AppEnumCollectionAnalysisFrameworkRoleType!])

LeadConfidentiality ([AppEnumCollectionLeadConfidentiality!])

LeadStatus ([AppEnumCollectionLeadStatus!])

LeadPriority ([AppEnumCollectionLeadPriority!])

LeadSourceType ([AppEnumCollectionLeadSourceType!])

LeadExtractionStatus ([AppEnumCollectionLeadExtractionStatus!])

LeadAutoEntryExtractionStatus ([AppEnumCollectionLeadAutoEntryExtractionStatus!])

EntryEntryType ([AppEnumCollectionEntryEntryType!])

ExportFormat ([AppEnumCollectionExportFormat!])

ExportStatus ([AppEnumCollectionExportStatus!])

ExportType ([AppEnumCollectionExportType!])

ExportExportType ([AppEnumCollectionExportExportType!])

GenericExportFormat ([AppEnumCollectionGenericExportFormat!])

GenericExportStatus ([AppEnumCollectionGenericExportStatus!])

GenericExportType ([AppEnumCollectionGenericExportType!])

ExportExcelSelectedColumnSerializerStaticColumn ([AppEnumCollectionExportExcelSelectedColumnSerializerStaticColumn!])

ExportExtraOptionsSerializerDateFormat ([AppEnumCollectionExportExtraOptionsSerializerDateFormat!])

ExportExtraOptionsSerializerReportCitationStyle ([AppEnumCollectionExportExtraOptionsSerializerReportCitationStyle!])

EntryReviewCommentCommentType ([AppEnumCollectionEntryReviewCommentCommentType!])

DiscardedEntryTag ([AppEnumCollectionDiscardedEntryTag!])

TopicModelStatus ([AppEnumCollectionTopicModelStatus!])

AutomaticSummaryStatus ([AppEnumCollectionAutomaticSummaryStatus!])

AnalyticalStatementNGramStatus ([AppEnumCollectionAnalyticalStatementNGramStatus!])

AnalyticalStatementGeoTaskStatus ([AppEnumCollectionAnalyticalStatementGeoTaskStatus!])

AnalysisReportUploadType ([AppEnumCollectionAnalysisReportUploadType!])

AnalysisReportContainerContentType ([AppEnumCollectionAnalysisReportContainerContentType!])

AnalysisReportVariableSerializerType ([AppEnumCollectionAnalysisReportVariableSerializerType!])

AnalysisReportTextStyleSerializerAlign ([AppEnumCollectionAnalysisReportTextStyleSerializerAlign!])

AnalysisReportBorderStyleSerializerStyle ([AppEnumCollectionAnalysisReportBorderStyleSerializerStyle!])

AnalysisReportImageContentStyleSerializerFit ([AppEnumCollectionAnalysisReportImageContentStyleSerializerFit!])

AnalysisReportHeadingConfigurationSerializerVariant ([AppEnumCollectionAnalysisReportHeadingConfigurationSerializerVariant!])

AnalysisReportHorizontalAxisSerializerType ([AppEnumCollectionAnalysisReportHorizontalAxisSerializerType!])

AnalysisReportBarChartConfigurationSerializerType ([AppEnumCollectionAnalysisReportBarChartConfigurationSerializerType!])

AnalysisReportBarChartConfigurationSerializerDirection ([AppEnumCollectionAnalysisReportBarChartConfigurationSerializerDirection!])

AnalysisReportCategoricalLegendStyleSerializerPosition ([AppEnumCollectionAnalysisReportCategoricalLegendStyleSerializerPosition!])

AnalysisReportCategoricalLegendStyleSerializerShape ([AppEnumCollectionAnalysisReportCategoricalLegendStyleSerializerShape!])

AnalysisReportVerticalAxisSerializerAggregationType ([AppEnumCollectionAnalysisReportVerticalAxisSerializerAggregationType!])

AnalysisReportMapLayerConfigurationSerializerType ([AppEnumCollectionAnalysisReportMapLayerConfigurationSerializerType!])

AnalysisReportSymbolLayerConfigurationSerializerScaleType ([AppEnumCollectionAnalysisReportSymbolLayerConfigurationSerializerScaleType!])

AnalysisReportSymbolLayerConfigurationSerializerScalingTechnique ([AppEnumCollectionAnalysisReportSymbolLayerConfigurationSerializerScalingTechnique!])

AnalysisReportLineLayerStyleSerializerStrokeType ([AppEnumCollectionAnalysisReportLineLayerStyleSerializerStrokeType!])

NotificationNotificationType ([AppEnumCollectionNotificationNotificationType!])

NotificationStatus ([AppEnumCollectionNotificationStatus!])

ConnectorSourceSource ([AppEnumCollectionConnectorSourceSource!])

ConnectorSourceStatus ([AppEnumCollectionConnectorSourceStatus!])

ConnectorLeadExtractionStatus ([AppEnumCollectionConnectorLeadExtractionStatus!])

DraftEntryPredictionStatus ([AppEnumCollectionDraftEntryPredictionStatus!])

AssistedTaggingPredictionDataType ([AppEnumCollectionAssistedTaggingPredictionDataType!])

DraftEntryType ([AppEnumCollectionDraftEntryType!])

UnusedAssessmentMethodologyProtectionInfo ([AppEnumCollectionUnusedAssessmentMethodologyProtectionInfo!])

AssessmentRegistryBgCrisisType ([AppEnumCollectionAssessmentRegistryBgCrisisType!])

AssessmentRegistryBgPreparedness ([AppEnumCollectionAssessmentRegistryBgPreparedness!])

AssessmentRegistryExternalSupport ([AppEnumCollectionAssessmentRegistryExternalSupport!])

AssessmentRegistryCoordinatedJoint ([AppEnumCollectionAssessmentRegistryCoordinatedJoint!])

AssessmentRegistryDetailsType ([AppEnumCollectionAssessmentRegistryDetailsType!])

AssessmentRegistryFamily ([AppEnumCollectionAssessmentRegistryFamily!])

AssessmentRegistryStatus ([AppEnumCollectionAssessmentRegistryStatus!])

AssessmentRegistryFrequency ([AppEnumCollectionAssessmentRegistryFrequency!])

AssessmentRegistryConfidentiality ([AppEnumCollectionAssessmentRegistryConfidentiality!])

AssessmentRegistryLanguage ([AppEnumCollectionAssessmentRegistryLanguage!])

AssessmentRegistryFocuses ([AppEnumCollectionAssessmentRegistryFocuses!])

AssessmentRegistrySectors ([AppEnumCollectionAssessmentRegistrySectors!])

AssessmentRegistryProtectionInfoMgmts ([AppEnumCollectionAssessmentRegistryProtectionInfoMgmts!])

AssessmentRegistryProtectionRisks ([AppEnumCollectionAssessmentRegistryProtectionRisks!])

AssessmentRegistryAffectedGroups ([AppEnumCollectionAssessmentRegistryAffectedGroups!])

MethodologyAttributeDataCollectionTechnique ([AppEnumCollectionMethodologyAttributeDataCollectionTechnique!])

MethodologyAttributeSamplingApproach ([AppEnumCollectionMethodologyAttributeSamplingApproach!])

MethodologyAttributeProximity ([AppEnumCollectionMethodologyAttributeProximity!])

MethodologyAttributeUnitOfAnalysis ([AppEnumCollectionMethodologyAttributeUnitOfAnalysis!])

MethodologyAttributeUnitOfReporting ([AppEnumCollectionMethodologyAttributeUnitOfReporting!])

AdditionalDocumentDocumentType ([AppEnumCollectionAdditionalDocumentDocumentType!])

ScoreRatingScoreType ([AppEnumCollectionScoreRatingScoreType!])

ScoreRatingRating ([AppEnumCollectionScoreRatingRating!])

ScoreAnalyticalDensitySector ([AppEnumCollectionScoreAnalyticalDensitySector!])

ScoreAnalyticalDensityAnalysisLevelCovered ([AppEnumCollectionScoreAnalyticalDensityAnalysisLevelCovered!])

ScoreAnalyticalDensityFigureProvided ([AppEnumCollectionScoreAnalyticalDensityFigureProvided!])

SummarySubDimensionIssueSector ([AppEnumCollectionSummarySubDimensionIssueSector!])

SummaryIssueSubPillar ([AppEnumCollectionSummaryIssueSubPillar!])

SummaryIssueSubDimension ([AppEnumCollectionSummaryIssueSubDimension!])

SummaryFocusSector ([AppEnumCollectionSummaryFocusSector!])

AssessmentRegistryOrganizationOrganizationType ([AppEnumCollectionAssessmentRegistryOrganizationOrganizationType!])


Fields

Name Description

enum (AnalysisFrameworkRoleTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (AnalysisReportUploadTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (AssessmentRegistryFamilyTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (AssessmentRegistryFocusTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (AssessmentRegistryStatusTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (AutomaticSummaryStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ConnectorSourceSourceEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ConnectorSourceStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (DiscardedEntryTagTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (DraftEntryPredictionStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (DraftEntryTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (EntryTagTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (EntryReviewCommentTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ExportExportTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ExportFormatEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ExportStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ExportDataTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (WidgetFilterTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (GenericExportFormatEnum!)

label (String!)

description (String)


Fields

Name Description

enum (GenericExportStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (GenericExportDataTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (GroupMembershipRoleEnum!)

label (String!)

description (String)


Fields

Name Description

enum (LeadConfidentialityEnum!)

label (String!)

description (String)


Fields

Name Description

enum (LeadExtractionStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (LeadPriorityEnum!)

label (String!)

description (String)


Fields

Name Description

enum (LeadSourceTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (LeadStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (NotificationTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (NotificationStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (UserEmailConditionOptOutEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ProjectJoinRequestStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ProjectMembershipBadgeTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ProjectRoleTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ProjectStatsActionEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ProjectStatsStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (ProjectStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (AssessmentRegistryRatingType!)

label (String!)

description (String)


Fields

Name Description

enum (AssessmentRegistrySectorTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (TopicModelStatusEnum!)

label (String!)

description (String)


Fields

Name Description

enum (UserEmailConditionOptOutEnum!)

label (String!)

description (String)


Fields

Name Description

enum (WidgetWidgetTypeEnum!)

label (String!)

description (String)


Fields

Name Description

enum (WidgetWidthTypeEnum!)

label (String!)

description (String)


Fields

Name Description

date (Date!)

count (Int!)

affectedGroup (AssessmentRegistryAffectedGroupTypeEnum!)

affectedGroupDisplay (EnumDescription!)


Fields

Name Description

adminLevelId (ID!)

region (ID!)

geoArea (ID!)

dataCollectionTechnique (AssessmentRegistryDataCollectionTechniqueTypeEnum!)

count (Int!)

dataCollectionTechniqueDisplay (EnumDescription!)


Fields

Name Description

adminLevelId (ID!)

region (ID!)

geoArea (ID!)

proximity (AssessmentRegistryProximityTypeEnum!)

count (Int!)

proximityDisplay (EnumDescription!)


Fields

Name Description

adminLevelId (ID!)

region (ID!)

geoArea (ID!)

samplingApproach (AssessmentRegistrySamplingApproachTypeEnum!)

count (Int!)

samplingApproachDisplay (EnumDescription!)


Fields

Name Description

adminLevelId (ID!)

region (ID!)

geoArea (ID!)

unitOfAnalysis (AssessmentRegistryUnitOfAnalysisTypeEnum!)

count (Int!)

unitOfAnalysisDisplay (EnumDescription!)


Fields

Name Description

adminLevelId (ID!)

region (ID!