Resources

name path methods description
AccountsApi
  • /account
  • /account/credits
  • /account/invitations
  • /account/manager
  • /account/product
  • /account/seats
  • /account/settings
  • /account/usage
  • /account/invitations/{id}
  • /account/managedUsers/{userId}
  • /account/product/migration
  • /account/invitations/{id}/accept
  • /account/invitations/{id}/reject
  • GET
  • GET POST
  • GET POST
  • DELETE
  • GET PUT
  • GET PUT
  • GET PUT
  • GET
  • DELETE
  • DELETE
  • DELETE
  • PUT
  • PUT
ModelsApi
  • /models
  • /models/create
  • /models/invitations
  • /models/{id}
  • /models/{id}/projects
  • /models/{id}/share
  • /models/{id}/versions
  • /models/invitations/{invitationId}/accept
  • /models/invitations/{invitationId}/reject
  • /models/{id}/invitations/{invitationId}
  • /models/{id}/userRights/{accessId}
  • /models/{id}/versions/{version}
  • GET POST
  • POST
  • GET
  • DELETE GET PUT
  • GET
  • POST
  • GET
  • PUT
  • PUT
  • DELETE
  • DELETE
  • GET
This section of the API encompasses functionality to create, edit and share saved Explorer models.
PolesApi
  • /poles
  • /poles/{id}
  • /poles/{id}/suggest
  • GET POST
  • DELETE GET PUT
  • GET
ProjectsApi
  • /projects
  • /projects/folders
  • /projects/languages
  • /projects/{id}
  • /projects/folders/{folderId}
  • /projects/folders/{id}
  • /projects/{id}/append
  • /projects/{id}/details
  • /projects/{id}/explore
  • /projects/{id}/model
  • /projects/{id}/reports
  • /projects/{id}/stories
  • /projects/{id}/suggestions
  • /projects/{id}/columns/{columnHeaderId}
  • /projects/{id}/history/{historyId}
  • /projects/{id}/reports/{reportId}
  • /projects/{id}/result/cells
  • /projects/{id}/result/searchTerms
  • /projects/folders/{id}/folders/{subFolderId}
  • /projects/folders/{id}/projects/{projectId}
  • /projects/{id}/explore/coverageStatistics/tonalities
  • /projects/{id}/explore/graphs/associations_timeseries
  • /projects/{id}/explore/graphs/averagescore
  • /projects/{id}/explore/graphs/highimpact
  • /projects/{id}/explore/graphs/highimpactassociation
  • /projects/{id}/explore/graphs/netsentiment_timeseries
  • /projects/{id}/explore/projectTonalities/tonalities
  • /projects/{projectId}/headers/{columnHeaderId}/samples
  • /projects/{projectId}/headers/{columnHeaderId}/validateFilterFormat
  • /projects/{id}/explore/groups/{groupId}/tonalities
  • /projects/{id}/explore/groups/{groupId}/topics/{topicId}/tonalities
  • GET POST
  • GET POST
  • GET
  • DELETE GET PUT
  • PUT
  • DELETE GET
  • POST
  • GET
  • GET POST
  • PUT
  • GET POST
  • GET POST
  • POST
  • GET
  • DELETE
  • DELETE GET
  • GET
  • GET
  • DELETE PUT
  • DELETE PUT
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET POST
  • GET
  • GET
  • GET POST
  • GET POST
This section of the API encompasses functionality relating to Explorer projects. A working knowledge of the Gavagai Explorer GUI is needed to properly understand the functionality detailed here. For a general introduction to the Gavagai Explorer, refer to the general Explorer documentation.
StatusApi
  • /status
  • GET

Data Types

JSON

type description
Account
AssociationsTimeseriesGraphData
AssociationsTimeseriesGraphDataRequest
AverageScoreGraphDataRequest
AverageScoreGraphDataResponse
CellTonality
CellTopicInformation
ColumnHeader
ConceptFilter
CoverageStatistics
DocumentReference
DocumentSentences
ExplorationState
ExplorationStatus
Filter
FilterOperator
FilterValidation
FolderInformation
FolderRequest
FolderStructure
GraphDataProgress
GraphStatus
GroupDefinition
HealthCheckReport
HealthCheckResult
HealthCheckType
HighImpactAssociationGraphDataRequest
HighImpactAssociationGraphDataResponse
HighImpactGraphDataRequest
HighImpactGraphDataResponse
HighImpactTopicAssociation
HighImpactTopicAssociationsGraphData
HistoryLog
IgnoreTerm
IgnoreTermChangeSet
Language
ManagerInvitation
MetadataCell
Model
ModelAccess
ModelChangeSet
ModelGroup
ModelGroupInput
ModelInfo
ModelInput
ModelInvitation
ModelProjects
ModelType
ModelUpdate
ModelVersion
NetSentimentTimeseriesGraphDataRequest
NetSentimentTimeseriesGraphDataResponse
Pole
Pole
PolePart
PolePart
PoleSuggestion
PoleSuggestions
PolesResponse
ProductPlan
Project
ProjectDocumentTonalities
ProjectExplorationContext
ProjectExplorationResponse
ProjectId
ProjectInfo
ProjectReport
ProjectRequest
ProjectSetting
ProjectStatus
ReportStatus
ReportType Type of report.
Resolution
RightsType
Row
RowsData
SelectedMetaData
Sentence
StoriesRequest
StoriesResponse
Story
Suggestion
SuggestionsRequest
SuggestionsResult
SynonymTerm
TermDetails
TonalitiesRequestContext
TonalitiesResponse
Tonality
TonalityContext
TonalityOrder
TonalityStatus
Topic
Topic
TopicAssociation
TopicAssociation
TopicAssociationsDataPoint
TopicAverageScore
TopicCell
TopicChangeSet
TopicChangeType
TopicDefinition
TopicGroupRequest
TopicGroupResponse
TopicHighImpact
TopicInput
TopicNetSentimentDataPoint
TopicRequest
TopicTermChangeSet
UsageDetails Holds usage information, that is, the number of Explorer projects and verbatims used per time period.
User
UserCredits
UserSeats
UserSetting

XML

Default Namespace
type description
tonalitiesRequestContext