Skip to content

Repository files navigation

gateway-api-sdk

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • Package version: 0.0.0-test6
  • Generator version: 7.24.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/HDRUK/gateway-api-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/HDRUK/gateway-api-python-sdk.git)

Then import the package:

import gateway_api_sdk

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 gateway_api_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import gateway_api_sdk
from gateway_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gateway_api_sdk.Configuration(
    host = "http://localhost"
)

# 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 Bearer authorization (JWT): bearerAuth
configuration = gateway_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with gateway_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gateway_api_sdk.ApplicationApi(api_client)
    create_applications_request = gateway_api_sdk.CreateApplicationsRequest() # CreateApplicationsRequest | Application definition

    try:
        # ApplicationController@store
        api_response = api_instance.create_applications(create_applications_request)
        print("The response of ApplicationApi->create_applications:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApplicationApi->create_applications: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ApplicationApi create_applications POST /api/v1/applications ApplicationController@store
ApplicationApi delete_applications DELETE /api/v1/applications/{id} ApplicationController@delete
ApplicationApi edit_applications PATCH /api/v1/applications/{id} ApplicationController@edit
ApplicationApi fetch_all_applications GET /api/v1/applications ApplicationController@index
ApplicationApi fetch_all_sitemap GET /api/v1/sitemap SiteMapController@index
ApplicationApi fetch_applications GET /api/v1/applications/{id} ApplicationController@show
ApplicationApi patch_applications_client_id PATCH /api/v1/applications/{id}/clientid ApplicationController@generateClientIdById
ApplicationApi update_applications PUT /api/v1/applications/{id} ApplicationController@update
AuthenticationApi authentication POST /api/v1/auth AuthController@checkAuthorization
AuthenticationApi login POST /api/v1/auth/login AuthController@login
AuthenticationApi register POST /api/v1/auth/register AuthController@register
CancerTypeFilterApi get_cancer_type_filter GET /api/v1/cancer-type-filters/{filter_id} Get a single cancer type filter
CancerTypeFilterApi get_cancer_type_filters GET /api/v1/cancer-type-filters Get all cancer type filters
CollectionsApi count_unique_fields_collections GET /api/v1/collections/count/{field} CollectionController@count
CollectionsApi count_unique_fields_collections_v2 GET /api/v2/collections/count/{field} CollectionController@count
CollectionsApi create_collections POST /api/v2/collections CollectionController@store
CollectionsApi delete_collections_v2 DELETE /api/v2/collections/{id} Delete a collection
CollectionsApi edit_collections_v2 PATCH /api/v2/collections/{id} Edit a collection
CollectionsApi fetch_all_collections GET /api/v1/collections CollectionController@index
CollectionsApi fetch_all_collections_v2 GET /api/v2/collections CollectionController@index
CollectionsApi fetch_collections GET /api/v1/collections/{id} CollectionController@show
CollectionsApi fetch_collections_v2 GET /api/v2/collections/{id} CollectionController@show
CollectionsApi update_collections_v2 PUT /api/v2/collections/{id} Update a collection
CustomerSatisfactionApi create_csat POST /api/v1/csat Create Customer Satisfaction Score
CustomerSatisfactionApi edit_csat PATCH /api/v1/csat/{id} Update Customer Satisfaction Description
DarIntegrationApi create_dar_integration POST /api/v1/dar-integration/{id} DarIntegration@store
DarIntegrationApi delete_dar_integration DELETE /api/v1/dar-integrations/{id} DarIntegration@destroy
DarIntegrationApi edit_dar_integration PATCH /api/v1/dar-integration/{id} DarIntegration@edit
DarIntegrationApi fetch_all_dar_integrations GET /api/v1/dar-integration DarIntegration@index
DarIntegrationApi fetch_dar_integration GET /api/v1/dar-integration/{id} DarIntegration@show
DarIntegrationApi update_dar_integration PUT /api/v1/dar-integration/{id} DarIntegration@update
DataAccessApplicationApi delete_team_dar_application_file DELETE /api/v1/teams/{teamId}/dar/applications/{id}/files/{fileId} DataAccessApplication@destroyFile
DataAccessApplicationApi fetch_team_dar_application_answers GET /api/v1/teams/{teamId}/dar/applications/{id}/answers DataAccessApplication@showAnswers
DataAccessApplicationApi fetch_team_dar_application_download_zip GET /api/v1/teams/{teamId}/dar/applications/{id}/download DataAccessApplication@download
DataAccessApplicationApi fetch_team_dar_application_file GET /api/v1/teams/{teamId}/dar/applications/{id}/files/{fileId}/download DataAccessApplication@downloadFile
DataAccessApplicationApi fetch_team_dar_application_files GET /api/v1/teams/{teamId}/dar/applications/{id}/files DataAccessApplication@showFiles
DataAccessApplicationApi fetch_team_dar_application_status_history GET /api/v1/teams/{teamId}/dar/applications/{id}/status DataAccessApplication@status
DataAccessApplicationApi update_team_dar_application PATCH /api/v1/teams/{teamId}/dar/applications/{id} DataAccessApplication@update
DataAccessApplicationReviewApi create_team_dar_application_question_review POST /api/v1/teams/{team_id}/dar/applications/{id}/questions/{questionId}/reviews DataAccessApplicationReview@store
DataAccessApplicationReviewApi create_team_dar_application_review POST /api/v1/teams/{team_id}/dar/applications/{id}/reviews DataAccessApplicationReview@storeGlobal
DataAccessApplicationReviewApi delete_team_dar_application_review_file DELETE /api/v1/teams/{teamId}/dar/applications/{id}/reviews/{reviewId}/files/{fileId} DataAccessApplicationReview@destroyFile
DataAccessApplicationReviewApi fetch_team_dar_application_review_file GET /api/v1/teams/{teamId}/dar/applications/{id}/reviews/{reviewId}/download/{fileId} DataAccessApplicationReview@downloadFile
DataAccessApplicationReviewApi fetch_team_dar_application_reviews GET /api/v1/teams/{team_id}/dar/applications/{id}/reviews DataAccessApplicationReview@index
DataAccessApplicationReviewApi update_team_dar_application_question_review PUT /api/v1/teams/{team_id}/dar/applications/{id}/questions/{questionId}/reviews/{reviewId} DataAccessApplicationReview@update
DataAccessApplicationReviewApi update_team_dar_application_review PUT /api/v1/teams/{team_id}/dar/applications/{id}/reviews/{reviewId} DataAccessApplicationReview@updateGlobal
DataAccessSectionApi create_dar_section POST /api/v1/dar/sections DataAccessSection@store
DataAccessSectionApi delete_dar_section DELETE /api/v1/dar/sections/{id} DataAccessSection@destroy
DataAccessSectionApi patch_dar_section PATCH /api/v1/dar/sections/{id} DataAccessSection@update
DataAccessSectionApi update_dar_section PUT /api/v1/dar/sections/{id} DataAccessSection@update
DataAccessTemplateApi create_dar_template POST /api/v1/dar/templates DataAccessTemplate@store
DataAccessTemplateApi delete_dar_template DELETE /api/v1/dar/templates/{id} DataAccessTemplate@destroy
DataAccessTemplateApi fetch_dar_template GET /api/v1/dar/templates/{id} DataAccessTemplate@show
DataAccessTemplateApi fetch_dar_templates GET /api/v1/dar/templates DataAccessTemplate@index
DataAccessTemplateApi patch_dar_template PATCH /api/v1/dar/templates/{id} DataAccessTemplate@update
DataAccessTemplateApi update_dar_template PUT /api/v1/dar/templates/{id} DataAccessTemplate@update
DataAccessTemplatesApi dar_template_count_unique_fields GET /api/v1/dar/templates/count/{field} DataAccessTemplateController@count
DataCustodianNetworksApi fetch_data_custodian_network GET /api/v2/data_custodian_networks/{id} DataCustodianNetworks@show
DataCustodianNetworksApi fetch_data_custodian_network_custodians_summary GET /api/v2/data_custodian_networks/{id}/custodians_summary DataCustodianNetworks@showCustodiansSummary
DataCustodianNetworksApi fetch_data_custodian_network_datasets_summary GET /api/v2/data_custodian_networks/{id}/datasets_summary DataCustodianNetworks@showDatasetsSummary
DataCustodianNetworksApi fetch_data_custodian_network_entities_summary GET /api/v2/data_custodian_networks/{id}/entities_summary DataCustodianNetworks@showSummary
DataCustodianNetworksApi fetch_data_custodian_network_info GET /api/v2/data_custodian_networks/{id}/info DataCustodianNetworks@showInfoSummary
DataCustodianNetworksApi fetch_data_custodian_networks GET /api/v2/data_custodian_networks DataCustodianNetworks@index
DataProviderCollApi fetch_data_provider_coll GET /api/v1/data_provider_colls/{id} DataProviderColl@show
DataProviderCollApi fetch_data_provider_coll_summary GET /api/v1/data_provider_colls/{id}/summary DataProviderColl@showSummary
DataProviderCollApi fetch_data_provider_colls GET /api/v1/data_provider_colls DataProviderColl@index
DataUseRegistersApi create_dur POST /api/v1/dur DurController@store
DataUseRegistersApi create_dur_by_team_v2 POST /api/v2/teams/{teamId}/dur TeamDurController@store
DataUseRegistersApi delete_dur DELETE /api/v1/dur/{id} Delete a dur
DataUseRegistersApi delete_durs_v2_by_team_id DELETE /api/v2/teams/{teamId}/dur/{id} TeamDurController@destroy
DataUseRegistersApi edit_dur PATCH /api/v1/dur/{id} Edit a dur
DataUseRegistersApi edit_durs_v2_by_team_id PATCH /api/v2/teams/{teamId}/dur/{id} TeamDurController@edit
DataUseRegistersApi export_dur_template GET /api/v1/dur/template DurController@exportTemplate
DataUseRegistersApi export_dur_template_v2 GET /api/v2/dur/template DurController@exportTemplate
DataUseRegistersApi export_dur_v2 GET /api/v2/dur/export DurController@export
DataUseRegistersApi fetch_all_dur GET /api/v1/dur DurController@index
DataUseRegistersApi fetch_all_dur_v2 GET /api/v2/dur DurController@indexActive
DataUseRegistersApi fetch_dur_by_id GET /api/v1/dur/{id} DurController@show
DataUseRegistersApi fetch_dur_by_id_v2 GET /api/v2/dur/{id} DurController@showActive
DataUseRegistersApi update_dur PUT /api/v1/dur/{id} Update a dur by id
DataUseRegistersApi update_dur_v2_by_team_id PUT /api/v2/teams/{teamId}/dur/{id} TeamDurController@update
DataUseRegistersApi upload_dur POST /api/v1/dur/upload DurController@upload
DatasetsApi count_unique_fields GET /api/v1/datasets/count/{field} DatasetController@count
DatasetsApi create_datasets POST /api/v1/datasets DatasetController@store
DatasetsApi create_datasets_integrations POST /api/v1/integrations/datasets IntegrationDatasetController@store
DatasetsApi create_datasets_v2 POST /api/v2/datasets DatasetController@store
DatasetsApi create_team_datasets_v2 POST /api/v2/teams/{teamId}/datasets TeamDatasetController@store
DatasetsApi delete_datasets DELETE /api/v1/datasets/{id} DatasetController@destroy
DatasetsApi delete_datasets_integrations DELETE /api/v1/integrations/datasets/{id} IntegrationDatasetController@destroy
DatasetsApi delete_datasets_v2 DELETE /api/v2/datasets/{id} Delete a dataset
DatasetsApi delete_team_datasets_v2 DELETE /api/v2/teams/{teamId}/datasets/{id} TeamDatasetController@destroy
DatasetsApi export_dataset_metadata GET /api/v1/datasets/export_metadata/{id} DatasetController@exportMetadata
DatasetsApi export_datasets GET /api/v1/datasets/export DatasetController@export
DatasetsApi export_dur GET /api/v1/dur/export DurController@export
DatasetsApi export_mock_dataset GET /api/v1/datasets/export/mock DatasetController@exportMock
DatasetsApi export_mock_dataset_v2 GET /api/v2/datasets/export/mock DatasetController@exportMock
DatasetsApi fetch_all_datasets GET /api/v1/datasets DatasetController@index
DatasetsApi fetch_all_datasets_integrations GET /api/v1/integrations/datasets IntegrationDatasetController@index
DatasetsApi fetch_all_datasets_v2 GET /api/v2/datasets DatasetController@index
DatasetsApi fetch_datasets GET /api/v1/datasets/{id} DatasetController@show
DatasetsApi fetch_datasets_integrations GET /api/v1/integrations/datasets/{id} IntegrationDatasetController@show
DatasetsApi fetch_datasets_v2 GET /api/v2/datasets/{id} DatasetController@showActive
DatasetsApi patch_datasets PATCH /api/v1/datasets/{id} DatasetController@edit
DatasetsApi patch_datasets_integrations PATCH /api/v1/integrations/datasets/{id} IntegrationDatasetController@edit
DatasetsApi patch_datasets_v2 PATCH /api/v2/datasets/{id} DatasetController@edit
DatasetsApi patch_team_datasets_v2 PATCH /api/v2/teams/{teamId}/datasets/{id} TeamDatasetController@edit
DatasetsApi update_datasets PUT /api/v1/datasets/{id} DatasetController@update
DatasetsApi update_datasets_integrations PUT /api/v1/integrations/datasets/{id} IntegrationDatasetController@update
DatasetsApi update_datasets_v2 PUT /api/v2/datasets/{id} DatasetController@update
DatasetsApi update_team_datasets_v2 PUT /api/v2/teams/{teamId}/datasets/{id} TeamDatasetController@update
FormHydrationApi get_form_schema GET /api/v1/form_hydration/schema Retrieve form schema data
FormHydrationApi onboarding_form_hydration GET /api/v1/form_hydration Retrieve form schema data
IntegrationCollectionsApi create_collections_integrations POST /api/v1/integrations/collections IntegrationCollectionController@store
IntegrationCollectionsApi delete_collections_integrations DELETE /api/v1/integrations/collections/{id} Delete a collection
IntegrationCollectionsApi edit_collections_integrations PATCH /api/v1/integrations/collections/{id} Edit a collection
IntegrationCollectionsApi fetch_all_collections_integrations GET /api/v1/integrations/collections IntegrationCollectionController@index
IntegrationCollectionsApi fetch_collections_integrations GET /api/v1/integrations/collections/{id} IntegrationCollectionController@show
IntegrationCollectionsApi update_collections_integrations PUT /api/v1/integrations/collections/{id} Update a collection
IntegrationDataUseRegistersApi create_dur_integrations POST /api/v1/integrations/dur IntegrationDurController@store
IntegrationDataUseRegistersApi delete_dur_integrations DELETE /api/v1/integrations/dur/{id} Delete a dur
IntegrationDataUseRegistersApi edit_dur_integrations PATCH /api/v1/integrations/dur/{id} Edit a dur
IntegrationDataUseRegistersApi fetch_all_dur_integrations GET /api/v1/integrations/dur IntegrationDurController@index
IntegrationDataUseRegistersApi fetch_dur_by_id_integrations GET /api/v1/integrations/dur/{id} IntegrationDurController@show
IntegrationDataUseRegistersApi update_dur_integrations PUT /api/v1/integrations/dur/{id} Update a dur by id
IntegrationsDatasetsTestApi integrations_datasets_test POST /api/v1/integrations/datasets/test IntegrationDatasetController@datasetTest
LicenseApi fetch_all_licenses GET /api/v1/licenses License@index
LicenseApi fetch_licenses GET /api/v1/licenses/{id} License@show
MetricsApi fetch_key_metrics_v2 GET /api/v2/metrics KeyMetricController@index
ProjectGrantApi fetch_all_project_grants GET /api/v1/project_grants ProjectGrantController@index
ProjectGrantApi fetch_project_grant GET /api/v1/project_grants/{id} ProjectGrantController@show
PublicationApi count_unique_fields_publications GET /api/v1/publication/count/{field} PublicationController@count
PublicationApi create_publications POST /api/v1/publications PublicationController@store
PublicationApi delete_publications DELETE /api/v1/publications/{id} PublicationController@destroy
PublicationApi edit_publications PATCH /api/v1/publications/{id} PublicationController@edit
PublicationApi fetch_all_publications GET /api/v1/publications PublicationController@index
PublicationApi fetch_all_publications_v2 GET /api/v2/publications PublicationController@indexActive
PublicationApi fetch_publications GET /api/v1/publications/{id} PublicationController@show
PublicationApi fetch_publications_v2 GET /api/v2/publications/{id} PublicationController@showActive
PublicationApi update_publications PUT /api/v1/publications/{id} PublicationController@update
QuestionBankApi create_question_bank_question POST /api/v1/questions QuestionBank@store
QuestionBankApi delete_question_bank_question DELETE /api/v1/questions/{id} QuestionBank@destroy
QuestionBankApi download_question_bank_question_file GET /api/v1/questions/{id}/files/{fileId} QuestionBank@destroyFile
QuestionBankApi edit_question_bank_question PATCH /api/v1/questions/{id} QuestionBank@update
QuestionBankApi fetch_archived_question_bank_questions GET /api/v1/questions/archived QuestionBank@indexArchived
QuestionBankApi fetch_custom_question_bank_questions GET /api/v1/questions/custom QuestionBank@indexCustom
QuestionBankApi fetch_question_bank_question GET /api/v1/questions/{id} QuestionBank@show
QuestionBankApi fetch_question_bank_question_version GET /api/v1/questions/version/{id} QuestionBank@showVersion
QuestionBankApi fetch_question_bank_questions GET /api/v1/questions QuestionBank@index
QuestionBankApi fetch_standard_question_bank_questions GET /api/v1/questions/standard QuestionBank@indexStandard
QuestionBankApi fetch_team_question_bank_questions_by_section GET /api/v1/teams/{teamId}/questions/section/{sectionId} TeamQuestionBank@indexBySection
QuestionBankApi update_question_bank_question PUT /api/v1/questions/{id} QuestionBank@update
QuestionBankApi update_question_bank_question_status PATCH /api/v1/questions/{id}/{status} QuestionBank@updateStatus
SearchCollectionsApi search_collections POST /api/v1/search/collections Search@collections
SearchDataCustodianNetworksApi search_data_custodian_networks POST /api/v1/search/data_custodian_networks Search@data_custodian_networks
SearchDataCustodiansApi search_data_custodians POST /api/v1/search/data_custodians Search@data_custodians
SearchDataUsesApi search_data_uses POST /api/v1/search/dur Search@data_uses
SearchDatasetsApi search_datasets POST /api/v1/search/datasets Search@datasets
SearchPublicationsApi search_publications POST /api/v1/search/publications Search@publications
SearchPublicationsApi search_publications_by_doi POST /api/v1/search/doi Search@publications
SearchSimilarDatasetsApi search_similar_datasets POST /api/v1/search/similar/datasets Search@similarDatasets
SearchToolsApi search_tools POST /api/v1/search/tools Search@tools
TeamDataAccessApplicationApi count_team_dar_applications GET /api/v1/teams/{teamId}/dar/applications/count TeamDataAccessApplicationController@allCounts
TeamDataAccessApplicationApi count_unique_fields_dar_applications GET /api/v1/teams/{teamId}/dar/applications/count/{field} TeamDataAccessApplicationController@count
TeamDataAccessApplicationApi fetch_team_dar_application GET /api/v1/teams/{teamId}/dar/applications/{id} TeamDataAccessApplicationController@show
TeamDataAccessApplicationApi fetch_team_dar_applications GET /api/v1/teams/{teamId}/dar/applications TeamDataAccessApplicationController@index
TeamDataAccessTemplateApi delete_team_dar_template_file DELETE /api/v1/teams/{teamId}/dar/templates/{id}/files/{fileId} TeamDataAccessTemplateController@destroyFile
TeamDataAccessTemplateApi fetch_team_dar_templates GET /api/v1/teams/{teamId}/dar/templates TeamDataAccessTemplateController@index
TeamDataAccessTemplateApi team_dar_template_count_unique_fields GET /api/v1/teams/{teamId}/dar/templates/count/{field} TeamDataAccessTemplateController@count
TeamFederationsApi create_federation_team POST /api/v1/teams/{teamId}/federations FederationController@store
TeamFederationsApi delete_federation DELETE /api/v1/teams/{teamId}/federations/{federationId} FederationController@destroy
TeamFederationsApi edit_federation_team PATCH /api/v1/teams/{teamId}/federations/{federationId} FederationController@edit
TeamFederationsApi get_federation_by_federation_id_and_team_id GET /api/v1/teams/{teamId}/federations/{federationId} FederationController@show
TeamFederationsApi get_federation_history GET /api/v1/teams/{teamId}/federations/{federationId}/history FederationController@history
TeamFederationsApi get_federation_team_id GET /api/v1/teams/{teamId}/federations FederationController@index
TeamFederationsApi run_federation GET /api/v1/teams/{teamId}/federations/{federationId}/run FederationController@runNow
TeamFederationsApi test_federation POST /api/v1/teams/{teamId}/federations/test FederationController@testFederation
TeamFederationsApi update_federation_team PUT /api/v1/teams/{teamId}/federations/{federationId} FederationController@update
ToolsApi count_unique_fields_tools GET /api/v1/tools/count/{field} ToolController@count
ToolsApi create_tools POST /api/v1/tools ToolController@store
ToolsApi create_tools_by_team_v2 POST /api/v2/teams/{teamId}/tools ToolController@store
ToolsApi create_tools_integrations POST /api/v1/integrations/tools IntegrationToolController@store
ToolsApi delete_tools DELETE /api/v1/tools/{id} ToolController@destroy
ToolsApi delete_tools_by_teamid_v2 DELETE /api/v2/teams/{teamId}/tools/{id} TeamToolController@destroy
ToolsApi delete_tools_integrations DELETE /api/v1/integrations/tools/{id} IntegrationToolController@destroy
ToolsApi edit_tools PATCH /api/v1/tools/{id} ToolController@edit
ToolsApi edit_tools_by_teamid_v2 PATCH /api/v2/teams/{teamId}/tools/{id} TeamToolController@edit
ToolsApi edit_tools_integrations PATCH /api/v1/integrations/tools/{id} IntegrationToolController@edit
ToolsApi fetch_all_tools GET /api/v1/tools Fetch all tools
ToolsApi fetch_all_tools_integrations GET /api/v1/integrations/tools IntegrationToolController@index
ToolsApi fetch_all_tools_v2 GET /api/v2/tools ToolController@indexActive
ToolsApi fetch_tools GET /api/v1/tools/{id} ToolController@show
ToolsApi fetch_tools_integrations GET /api/v1/integrations/tools/{id} IntegrationToolController@show
ToolsApi fetch_tools_v2 GET /api/v2/tools/{id} ToolController@showActive
ToolsApi update_tools PUT /api/v1/tools/{id} ToolController@update
ToolsApi update_tools_by_teamid_v2 PUT /api/v2/teams/{teamId}/tools/{id} TeamToolController@update
ToolsApi update_tools_integrations PUT /api/v1/integrations/tools/{id} IntegrationToolController@update
UsersApi verify_secondary_email GET /api/v1/users/verify-secondary-email/{uuid} Verify user's secondary email using a UUID
WidgetsApi create_widget POST /api/v1/teams/{teamId}/widgets Create a new widget
WidgetsApi delete_widget DELETE /api/v1/teams/{teamId}/widgets/{id} Delete a widget
WidgetsApi fetch_all_widgets GET /api/v1/teams/{teamId}/widgets WidgetController@index
WidgetsApi fetch_widget GET /api/v1/teams/{teamId}/widgets/{id} WidgetController@retrieve
WidgetsApi fetch_widget_data_sources GET /api/v1/teams/{teamId}/widgets/data WidgetController@getWidgetData
WidgetsApi retrieve_widget_data GET /api/v1/teams/{teamId}/widgets/{id}/data Retrieve data related to a widget
WidgetsApi track_widget_event POST /api/v1/teams/{teamId}/widgets/{id}/track Record a widget analytics event
WidgetsApi update_widget PATCH /api/v1/teams/{teamId}/widgets/{id} Update an existing widget
WidgetsApi widget_analytics GET /api/v1/teams/{teamId}/widgets/analytics Get widget analytics for a team
DatasetsTestApi datasets_test POST /api/v1/datasets/test DatasetController@datasetTest

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

Author

About

No description or website provided.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages