Skip to content

gavagai-corp/explorer-python-client

BranchesTags

Repository files navigation

explorer-client

This is the technical documentation for the Gavagai Explorer API.

We recommend that you get familiar with using Gavagai Explorer before you start developing with the API. The Explorer has its own general documentation.

Make sure that you understand the basic procedures, such as creating projects and uploading texts, exploring and refining your project, or creating reports and applying models. All functionality in Gavagai Explorer is built on this API, so you will have a much easier time understanding the different steps if you have already seen them in the Explorer web interface.

The Getting Started tutorial and the Common Use Cases section provide more guidance in understanding how the different API calls can be fitted together to create a workflow. The documentation below then provides full technical specifics for each endpoint.

Requirements.

Python 3.4+

Installation & Usage

pip install

You can install the python package directly using:

pip install git+https://github.com/gavagai-corp/explorer-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/gavagai-corp/explorer-python-client.git)

Then import the package:

import explorer_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import explorer_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import explorer_client
from explorer_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.gavagai.se/explorer/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = explorer_client.Configuration(
    host = "https://api.gavagai.se/explorer/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = explorer_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)


# Enter a context with an instance of the API client
with explorer_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = explorer_client.AccountsApi(api_client)
    id = 56 # int | Id of the invitation

    try:
        # Acccept Manager Invitation
        api_instance.accept_manager_invitation(id)
    except ApiException as e:
        print("Exception when calling AccountsApi->accept_manager_invitation: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.gavagai.se/explorer/v1

Class Method HTTP request Description
AccountsApi accept_manager_invitation PUT /account/invitations/{id}/accept Acccept Manager Invitation
AccountsApi cancel_account DELETE /account/cancel Cancel Account
AccountsApi cancel_product_plan_migration DELETE /account/product/migration Cancel Product Plan Migration
AccountsApi create_manager_invitation POST /account/invitations Create Manager Invitation
AccountsApi delete_managed_user DELETE /account/managedUsers/{userId} Delete Managed User
AccountsApi delete_manager DELETE /account/manager Delete manager
AccountsApi delete_manager_invitation DELETE /account/invitations/{id} Delete Manager Invitation
AccountsApi get_account GET /account Get Account
AccountsApi get_account_balance GET /account/balance Get Account Balance
AccountsApi get_credit_statistics GET /account/credits/statistics Get Credit Statistics
AccountsApi get_credits GET /account/credits Get Credits
AccountsApi get_manager_invitations GET /account/invitations Get Manager Invitations
AccountsApi get_pending_payment GET /account/pendingPayment Get Pending Payments
AccountsApi get_product_plan GET /account/product Get Product Plan
AccountsApi get_usage GET /account/usage Get Usage
AccountsApi get_user_settings GET /account/settings Get User Settings
AccountsApi purchase_credits POST /account/credits Purchase Credits
AccountsApi reactivate_account POST /account/reactivate Reactivate Account
AccountsApi reject_manager_invitation PUT /account/invitations/{id}/reject Reject Manager Invitation
AccountsApi set_product_plan PUT /account/product Set Product Plan
AccountsApi update_user_settings PUT /account/settings Update User Settings
DashboardsApi create_dashboard_graph POST /projects/{id}/explore/dashboard/graphs Create Graph
DashboardsApi create_topic_graph POST /projects/{id}/explore/dashboard/topic_graphs Create topic Graphs
DashboardsApi delete_dashboard_graph DELETE /projects/{id}/explore/dashboard/graphs/{graphId} Delete Graph
DashboardsApi delete_topic_graph DELETE /projects/{id}/explore/dashboard/topic_graphs/{graphId} Delete Topic Graph
DashboardsApi get_associations_timeseries_graph_data GET /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/associations_timeseries Get the Associations Timeseries graph data
DashboardsApi get_average_score_graph_data GET /projects/{id}/explore/dashboard/graphs/{graphId}/averagescore Get AvgScore Graph
DashboardsApi get_average_score_matrix_graph_data GET /projects/{id}/explore/dashboard/graphs/{graphId}/averagescore_matrix Get Average Score Matrix Data
DashboardsApi get_compiled_graph_share_data GET /projects/{id}/explore/dashboard/graphs/sharedata Retrieve the compiled graph data
DashboardsApi get_compiled_graph_share_data_progress GET /projects/{id}/explore/dashboard/graphs/sharedata/progress Retrieve the progress
DashboardsApi get_graphs_for_project GET /projects/{id}/explore/dashboard/graphs Get a list of graphs.
DashboardsApi get_grouped_comparison_graph_context GET /projects/{id}/explore/dashboard/graphs/comparison_grouped_context Get Grouped Comparison Graph Context
DashboardsApi get_grouped_comparison_graph_data GET /projects/{id}/explore/dashboard/graphs/{graphId}/grouped_comparison Get Grouped Comparison Graph
DashboardsApi get_high_impact_association_graph_container GET /projects/{id}/explore/dashboard/graphs/{graphId}/highimpactassociation Get High Impact Topic Associations Graph
DashboardsApi get_high_impact_graph_data GET /projects/{id}/explore/dashboard/graphs/{graphId}/highimpact Get High Impact Topics Graph
DashboardsApi get_net_sentiment_timeseries_graph_data GET /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/netsentiment_timeseries Get the Net Sentiment Timeseries
DashboardsApi get_timeseries_comparison_graph_data GET /projects/{id}/explore/dashboard/graphs/{graphId}/timeseries_comparison Get Time Series Comparison Graph
DashboardsApi get_topic_associations_graph_data GET /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/associations Get the association graph data
DashboardsApi get_topic_average_score_matrix_graph_data GET /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/averagescore_matrix Get the average score matrix
DashboardsApi get_topic_graphs GET /projects/{id}/explore/dashboard/topic_graphs Get topic Graphs
DashboardsApi get_topic_information_graph_data GET /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/topic_information Get the topic information graph
DashboardsApi get_topic_text_examples GET /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/text_examples Get the text examples for the selected topic
DashboardsApi initialize_dashboard POST /projects/{id}/explore/dashboard/initialize Initialize Dashboard
DashboardsApi modify_dashboard_graph PUT /projects/{id}/explore/dashboard/graphs/{graphId} Update Graph
DashboardsApi set_associations_timeseries_graph_context PUT /projects/{id}/explore/dashboard/topic_graphs/{graphId}/associations_timeseries Update the context of the Associations Timeseries graph data
DashboardsApi set_net_sentiment_timeseries_graph_context PUT /projects/{id}/explore/dashboard/topic_graphs/{graphId}/netsentiment_timeseries Update Net Sentiment Timeseries Context
DashboardsApi set_topic_average_score_matrix_graph_context PUT /projects/{id}/explore/dashboard/topic_graphs/{graphId}/averagescore_matrix Put the context of the Average Score Matrix
DashboardsApi set_topic_information_graph_context PUT /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topic_information Put the context of the Topic Information graph data
DashboardsApi set_topic_text_examples_context PUT /projects/{id}/explore/dashboard/topic_graphs/{graphId}/text_examples Put the context of the Topic Text examples graph data
DashboardsApi start_associations_timeseries_graph_data POST /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/associations_timeseries Start the Associations Timeseries
DashboardsApi start_average_score_graph_data POST /projects/{id}/explore/dashboard/graphs/{graphId}/averagescore Start AvgScore Calculation
DashboardsApi start_average_score_matrix_graph_data POST /projects/{id}/explore/dashboard/graphs/{graphId}/averagescore_matrix Start Average Score Matrix Calculation
DashboardsApi start_compile_graph_share_data POST /projects/{id}/explore/dashboard/graphs/sharedata Start Compiling Dashboard graphs
DashboardsApi start_grouped_comparison_graph_data POST /projects/{id}/explore/dashboard/graphs/{graphId}/grouped_comparison Start Grouped Comparison Calculation
DashboardsApi start_high_impact_association_graph_container POST /projects/{id}/explore/dashboard/graphs/{graphId}/highimpactassociation Start High Impact Topic Associations Calculation
DashboardsApi start_high_impact_graph_data POST /projects/{id}/explore/dashboard/graphs/{graphId}/highimpact Start High Impact Topic Calculation
DashboardsApi start_net_sentiment_timeseries_graph_data POST /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/netsentiment_timeseries Start the Net Sentiment Timeseries
DashboardsApi start_timeseries_comparison_graph_data POST /projects/{id}/explore/dashboard/graphs/{graphId}/timeseries_comparison Start Time Series Comparison Calculation
DashboardsApi start_topic_average_score_matrix_graph_data POST /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/averagescore_matrix Start the computation of the Average Score Matrix
DashboardsApi start_topic_information_graph_data POST /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/topic_information Start the computation of the Topic Information
DashboardsApi start_topic_text_examples POST /projects/{id}/explore/dashboard/topic_graphs/{graphId}/topics/{topicId}/text_examples Start the computation of the Topic Text
DashboardsApi update_topic_graph PUT /projects/{id}/explore/dashboard/topic_graphs/{graphId} Update topic Graphs
FileUtilitiesApi get_file_details POST /file-utilities/details Get File Details
FileUtilitiesApi get_first_row POST /file-utilities/header_row Get First Row
ModelsApi accept_invitation PUT /models/invitations/{invitationId}/accept Accept Model Invitations
ModelsApi create_model POST /models/create Create Model
ModelsApi get_model GET /models/{id} Get Model
ModelsApi get_model_invitations GET /models/invitations Get Model Invitations
ModelsApi get_model_projects GET /models/{id}/projects Get Projects
ModelsApi get_model_versions GET /models/{id}/versions Get Model Versions
ModelsApi get_models GET /models Get Models
ModelsApi get_versioned_model GET /models/{id}/versions/{version} Get Model Version
ModelsApi reject_invitation PUT /models/invitations/{invitationId}/reject Reject Model Invitations
ModelsApi remove_model DELETE /models/{id} Delete Model
ModelsApi remove_model_access DELETE /models/{id}/userRights/{accessId} Remove Model Access
ModelsApi remove_model_invitation DELETE /models/{id}/invitations/{invitationId} Remove Model Invitation
ModelsApi share_model POST /models/{id}/share Share Model
ModelsApi update_model PUT /models/{id} Update Model
ModelsApi upload_model_from_file POST /models Upload Model
PluginsApi get_plugin_details GET /plugins/{id} Get Plugin
PluginsApi get_plugins GET /plugins Get Plugins
PluginsApi get_survey GET /plugins/survey_monkey/surveys/{id} Get Survey
PluginsApi get_surveys GET /plugins/survey_monkey/surveys Get Surveys
PluginsApi import_survey POST /plugins/survey_monkey/surveys/{id}/import Import Survey
PluginsApi survey_monkey_auth GET /plugins/survey_monkey/auth Authenticate the survey monkey plugin
PluginsApi survey_monkey_callback GET /plugins/survey_monkey/callback Callback endpoint for the survey monkey plugin
PolesApi create_pole POST /poles Create Pole
PolesApi delete_pole DELETE /poles/{id} Delete Pole
PolesApi get_pole GET /poles/{id} Get Pole
PolesApi get_poles GET /poles Get Poles
PolesApi get_suggestions_for_pole GET /poles/{id}/suggest Get Pole Suggestions
PolesApi update_pole PUT /poles/{id} Update Pole
ProductsApi get_credit_price GET /products/creditPrice Get Credit Price
ProductsApi get_product_plans GET /products Get Product Plans
ProjectsApi add_folder_to_folder PUT /projects/folders/{id}/folders/{subFolderId} Add sub folder to folder
ProjectsApi add_project_to_folder PUT /projects/folders/{id}/projects/{projectId} Add project to folder
ProjectsApi append_to_project POST /projects/{id}/append Add data to project
ProjectsApi append_file_to_project POST /projects/{id}/append Add data to project
ProjectsApi create_batch POST /projects/{id}/batches Start Batch Calculation
ProjectsApi create_folder POST /projects/folders Create folder
ProjectsApi create_report POST /projects/{id}/reports Create report
ProjectsApi create_stories POST /projects/{id}/stories Create Stories
ProjectsApi explore_project POST /projects/{id}/explore Explore project
ProjectsApi find_suggestions POST /projects/{id}/suggestions Get suggestions for terms
ProjectsApi get_batch_result GET /projects/{id}/batches/{batchId} Get Batch Calculation
ProjectsApi get_cell_information GET /projects/{id}/result/cells Get cell data
ProjectsApi get_coverage_tonalities GET /projects/{id}/explore/coverageStatistics/tonalities Get Coverage Tonalities
ProjectsApi get_distinct_column_values GET /projects/{id}/columns/{columnHeaderId} Get distinct column values
ProjectsApi get_exploration GET /projects/{id}/explore Get Explore Results
ProjectsApi get_folder GET /projects/folders/{id} Get folder
ProjectsApi get_folders GET /projects/folders Get folders
ProjectsApi get_group_tonalities GET /projects/{id}/explore/groups/{groupId}/tonalities Get tonality response
ProjectsApi get_matching_sentences_for_terms GET /projects/{id}/sentences Get sentences
ProjectsApi get_project GET /projects/{id} Get project
ProjectsApi get_project_document_tonalities GET /projects/{id}/explore/projectTonalities/tonalities Get Document Tonalities
ProjectsApi get_project_languages GET /projects/languages Get all supported languages
ProjectsApi get_project_languages1 GET /projects/{id}/languages Get project languages
ProjectsApi get_project_report GET /projects/{id}/reports/{reportId} Retrieve report
ProjectsApi get_project_reports GET /projects/{id}/reports Get reports
ProjectsApi get_projects GET /projects Get all projects
ProjectsApi get_sample_texts GET /projects/{projectId}/headers/{columnHeaderId}/samples Get sample texts
ProjectsApi get_stories GET /projects/{id}/stories Get Stories
ProjectsApi get_term_details GET /projects/{id}/details Get topic details
ProjectsApi get_topic_tonalities GET /projects/{id}/explore/groups/{groupId}/topics/{topicId}/tonalities Get tonality response
ProjectsApi remove_folder DELETE /projects/folders/{id} Remove folder
ProjectsApi remove_folder_from_folder DELETE /projects/folders/{id}/folders/{subFolderId} Remove sub folder from folder
ProjectsApi remove_history DELETE /projects/{id}/history/{historyId} Remove history log
ProjectsApi remove_model_from_project DELETE /projects/{id}/model Detach model from project
ProjectsApi remove_project DELETE /projects/{id} Remove project
ProjectsApi remove_project_from_folder DELETE /projects/folders/{id}/projects/{projectId} Remove project from folder
ProjectsApi remove_report DELETE /projects/{id}/reports/{reportId} Remove report
ProjectsApi search_for_project_terms GET /projects/{id}/result/searchTerms Search Project Terms
ProjectsApi start_coverage_tonalities POST /projects/{id}/explore/coverageStatistics/tonalities Start Coverage Tonalities Calculation
ProjectsApi start_group_tonalities POST /projects/{id}/explore/groups/{groupId}/tonalities Start tonality calculation
ProjectsApi start_project_document_tonalities POST /projects/{id}/explore/projectTonalities/tonalities Start Document Tonalities
ProjectsApi start_topic_tonalities POST /projects/{id}/explore/groups/{groupId}/topics/{topicId}/tonalities Start tonality calculation
ProjectsApi update_folder PUT /projects/folders/{folderId} Update folder
ProjectsApi update_project PUT /projects/{id} Update project
ProjectsApi update_project_model PUT /projects/{id}/model Update Project Model
ProjectsApi upload_project POST /projects Create project
ProjectsApi upload_project_file POST /projects Create project
ProjectsApi validate_filter_date_format GET /projects/{projectId}/headers/{columnHeaderId}/validateFilterFormat Validate your data filter format
StatusApi ping_service GET /status Get System Status
TonalityCustomizationApi create_tonality_customization POST /tonality-customizations Create Tonality Customization
TonalityCustomizationApi delete_tonality_customization DELETE /tonality-customizations/{id} Delete Tonality Customization
TonalityCustomizationApi get_tonality_customization GET /tonality-customizations/{id} Get Tonality Customization
TonalityCustomizationApi get_tonality_customizations GET /tonality-customizations Get Tonality Customizations
TonalityCustomizationApi get_tonality_details_for_terms GET /tonality-customizations/details Get Term Tonalitites
TonalityCustomizationApi update_tonality_customization PUT /tonality-customizations/{id} Update Tonality Customization

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Author

About

A python client for Gavagai Explorer API

api.gavagai.se/explorer/v1/docs

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages