Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

name path methods description
AccountsApi
  • /account
  • /account/invitations
  • /account/manager
  • /account/settings
  • /account/usage
  • /account/invitations/{id}
  • /account/managedUsers/{userId}
  • /account/invitations/{id}/accept
  • /account/invitations/{id}/reject
  • GET
  • GET POST
  • DELETE
  • GET PUT
  • GET
  • DELETE
  • DELETE
  • PUT
  • PUT
ModelsApi
  • /models
  • /models/create
  • /models/invitations
  • /models/{id}
  • /models/{id}/groups
  • /models/{id}/share
  • /models/invitations/{invitationId}/accept
  • /models/invitations/{invitationId}/reject
  • /models/{id}/groups/{groupId}
  • /models/{id}/invitations/{invitationId}
  • /models/{id}/userRights/{accessId}
  • /models/{id}/groups/{groupId}/topics
  • /models/{id}/groups/{groupId}/topics/{topicId}
  • GET POST
  • POST
  • GET
  • DELETE GET PUT
  • GET
  • POST
  • PUT
  • PUT
  • DELETE GET PUT
  • DELETE
  • DELETE
  • GET
  • DELETE GET PUT
This section of the API encompasses functionality to create, edit and share saved Explorer models.
PluginsApi
  • /plugins
  • /plugins/{id}
  • /plugins/survey_monkey/auth
  • /plugins/survey_monkey/callback
  • /plugins/survey_monkey/surveys
  • /plugins/survey_monkey/surveys/{id}
  • /plugins/survey_monkey/surveys/{id}/import
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
ProjectsApi
  • /projects
  • /projects/folders
  • /projects/languages
  • /projects/{id}
  • /projects/folders/{id}
  • /projects/{id}/append
  • /projects/{id}/details
  • /projects/{id}/explore
  • /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/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
  • DELETE GET PUT
  • POST
  • GET
  • GET POST
  • GET POST
  • GET POST
  • POST
  • GET
  • DELETE
  • DELETE GET
  • GET
  • GET
  • DELETE PUT
  • DELETE PUT
  • 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.

Data Types

JSON

type description
Account
CellTonality
CellTopicInformation
ColumnHeader
ConceptFilter
CoverageStatistics
DocumentReference
DocumentSentences
ExplorationState
ExplorationStatus
Filter
FilterOperator
FilterValidation
FolderInformation
FolderRequest
FolderStructure
GroupDefinition
HistoryLog
IgnoreTerm
Language
ManagerInvitation
MetadataCell
Model
ModelAccess
ModelGroup
ModelGroupUpdate
ModelInvitation
ModelThin
ModelUpdate
Plugin
PluginDetails
PluginType
Project
ProjectDocumentTonalities
ProjectExplorationContext
ProjectExplorationResponse
ProjectId
ProjectInfo
ProjectReport
ProjectRequest
ProjectSetting
ProjectStatus
ReportStatus
ReportType Type of report.
RightsType
Row
RowsData
SelectedMetaData The metadata for the selected column from the same row as the corresponding document text.
Sentence
StoriesRequest
StoriesResponse
Story
Suggestion
SuggestionsRequest
SuggestionsResult
Survey
SurveyDetails
SynonymTerm
TermDetails
TonalitiesResponse
Tonality
TonalityContext
TonalityStatus
Topic
Topic
TopicAssociation
TopicCell
TopicDefinition
TopicGroupRequest
TopicGroupResponse
TopicInput
TopicRequest
UsageDetails Holds usage information, that is, the number of Explorer projects and verbatims used per time period.
User
UserSetting

XML

Default Namespace (schema)
type description
error Returned when there is an exception while calling an API method. Includes a result code and a message.
errorCode
folderInformation
folderRequest
folderStructure
user
account
managerInvitation
synonym
synonymGroup
synonymsResponse
timePeriod Short-hands for time periods.
usageDetails Holds usage information, that is, the number of Explorer projects and verbatims used per time period.
userSetting
plugin
pluginDetails
pluginMetadata
pluginType
page
survey
surveyDetails
columnHeader
conceptFilter
documentReference
filter
filterOperator
filterValidation
historyLog
project
projectExplorationContext
projectId
projectInfo
projectReport
projectRequest
projectSetting
projectStatus
reportStatus
reportType Type of report.
storiesResponse
story
suggestion
suggestionsRequest
suggestionsResult
topicGroupRequest
topicRequest
ignoreTerm
model
modelAccess
modelGroup
modelGroupInput
modelGroupUpdate
modelInput
modelInvitation
modelThin
modelUpdate
rightsType
topicInput
coverageStatistics
documentSentences
explorationState
explorationStatus
projectDocumentTonalities
projectExplorationResponse
selectedMetaData The metadata for the selected column from the same row as the corresponding document text.
sentence
synonymTerm
termDetails
tonality
tonalityContext
topic
topicAssociation
topicGroupResponse
language
row
rowsData
storiesRequest