mencoro 1.0.0__tar.gz

mencoro-1.0.0/PKG-INFO

@@ -0,0 +1,338 @@
+Metadata-Version: 2.4
+Name: mencoro
+Version: 1.0.0
+Summary: Mencoro API
+Home-page: 
+Author: Mencoro Support
+Author-email: Mencoro Support <support@mencoro.com>
+License: Proprietary
+Project-URL: Repository, https://github.com/mencoro/mencoro-api-sdk
+Keywords: OpenAPI,OpenAPI-Generator,Mencoro API
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.6.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+
+# mencoro
+Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Generator version: 7.24.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://mencoro.com/contact/](https://mencoro.com/contact/)
+
+## Requirements.
+
+Python 3.10+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/mencoro/mencoro-api-sdk.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/mencoro/mencoro-api-sdk.git`)
+
+Then import the package:
+```python
+import mencoro
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import mencoro
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import mencoro
+from mencoro.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.mencoro.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = mencoro.Configuration(
+    host = "https://api.mencoro.com"
+)
+
+# 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: ApiKey
+configuration = mencoro.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with mencoro.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = mencoro.AccountApi(api_client)
+
+    try:
+        # Get the authenticated identity
+        api_response = api_instance.get_me()
+        print("The response of AccountApi->get_me:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AccountApi->get_me: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.mencoro.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AccountApi* | [**get_me**](docs/AccountApi.md#get_me) | **GET** /api/v1/me | Get the authenticated identity
+*AccountApi* | [**get_me_stats**](docs/AccountApi.md#get_me_stats) | **GET** /api/v1/me/stats | Counts across everything the key can reach
+*AnalyticsApi* | [**get_available_filters**](docs/AnalyticsApi.md#get_available_filters) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/available-filters | Filter values a project is configured for
+*AnalyticsApi* | [**get_cited_sources**](docs/AnalyticsApi.md#get_cited_sources) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/cited-sources | Domains and pages the AI answers cited
+*AnalyticsApi* | [**get_cluster_breakdown**](docs/AnalyticsApi.md#get_cluster_breakdown) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/clusters | Rank-tracking metrics per keyword cluster
+*AnalyticsApi* | [**get_competitor_co_occurrence**](docs/AnalyticsApi.md#get_competitor_co_occurrence) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/co-occurrence | Head-to-head record of the brand against each tracked competitor
+*AnalyticsApi* | [**get_mention_mix**](docs/AnalyticsApi.md#get_mention_mix) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/mentions/mix | Composition of a project brand mentions in AI answers
+*AnalyticsApi* | [**get_mention_samples**](docs/AnalyticsApi.md#get_mention_samples) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/mentions | Sample of the raw AI mention texts of a project
+*AnalyticsApi* | [**get_metric_glossary**](docs/AnalyticsApi.md#get_metric_glossary) | **GET** /api/v1/metric-glossary | Map everyday wording to a metric and the operation that serves it
+*AnalyticsApi* | [**get_organization_overview**](docs/AnalyticsApi.md#get_organization_overview) | **GET** /api/v1/organizations/{organizationId}/overview | Snapshot rank-health board across an organization active projects
+*AnalyticsApi* | [**get_project_metrics**](docs/AnalyticsApi.md#get_project_metrics) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/metrics | Headline visibility metrics of a project
+*AnalyticsApi* | [**get_project_sentiment**](docs/AnalyticsApi.md#get_project_sentiment) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/sentiment | Sentiment breakdown of a project brand mentions
+*AnalyticsApi* | [**get_project_time_series**](docs/AnalyticsApi.md#get_project_time_series) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/timeseries | Rank-tracking metrics of a project over time
+*AnalyticsApi* | [**get_query_movers**](docs/AnalyticsApi.md#get_query_movers) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/movers | Tracked queries ranked by how much a metric moved
+*AnalyticsApi* | [**get_share_of_voice_formula**](docs/AnalyticsApi.md#get_share_of_voice_formula) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/share-of-voice-formula | The constants behind the Share of Voice score
+*AnalyticsApi* | [**get_tracked_query_time_series**](docs/AnalyticsApi.md#get_tracked_query_time_series) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/timeseries | Rank-tracking time series of a single tracked query
+*AnalyticsApi* | [**get_tracking_coverage**](docs/AnalyticsApi.md#get_tracking_coverage) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/coverage | Coverage and staleness of a project tracked queries
+*AnalyticsApi* | [**list_keyword_listings**](docs/AnalyticsApi.md#list_keyword_listings) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/keyword-listings | List a project&#39;s keywords with their windowed metrics
+*BillingApi* | [**get_subscription**](docs/BillingApi.md#get_subscription) | **GET** /api/v1/organizations/{organizationId}/subscription | Get the subscription of an organization
+*CapturesApi* | [**list_ai_responses**](docs/CapturesApi.md#list_ai_responses) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/ai-responses | List captured AI answers
+*CapturesApi* | [**list_search_snapshots**](docs/CapturesApi.md#list_search_snapshots) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/search-snapshots | List captured search-results pages
+*CapturesApi* | [**list_shopping_snapshots**](docs/CapturesApi.md#list_shopping_snapshots) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/shopping-snapshots | List captured shopping-results pages
+*ClustersApi* | [**apply_clustering_job**](docs/ClustersApi.md#apply_clustering_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/jobs/{jobId}/apply | Apply the result of a clustering job
+*ClustersApi* | [**batch_create_query_clusters**](docs/ClustersApi.md#batch_create_query_clusters) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/batch | Create several keyword clusters at once
+*ClustersApi* | [**create_query_cluster**](docs/ClustersApi.md#create_query_cluster) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters | Create a keyword cluster
+*ClustersApi* | [**delete_query_cluster**](docs/ClustersApi.md#delete_query_cluster) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} | Delete a keyword cluster
+*ClustersApi* | [**rename_query_cluster**](docs/ClustersApi.md#rename_query_cluster) | **PATCH** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} | Rename a keyword cluster
+*ClustersApi* | [**start_clustering_job**](docs/ClustersApi.md#start_clustering_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/jobs | Start a keyword clustering job
+*DiscoveryApi* | [**start_brand_discovery_job**](docs/DiscoveryApi.md#start_brand_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/brands | Start a brand discovery job for a project
+*DiscoveryApi* | [**start_brand_name_suggestion_job**](docs/DiscoveryApi.md#start_brand_name_suggestion_job) | **POST** /api/v1/organizations/{organizationId}/brand-name-suggestions | Start a brand-name alias suggestion job
+*DiscoveryApi* | [**start_keyword_discovery_job**](docs/DiscoveryApi.md#start_keyword_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/keywords | Start a keyword discovery job for a project
+*DiscoveryApi* | [**start_prompt_discovery_job**](docs/DiscoveryApi.md#start_prompt_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/prompts | Start a geo prompt discovery job for a project
+*InvitationsApi* | [**cancel_invitation**](docs/InvitationsApi.md#cancel_invitation) | **POST** /api/v1/organizations/{organizationId}/invitations/{invitationId}/cancel | Cancel a pending invitation
+*InvitationsApi* | [**create_invitation**](docs/InvitationsApi.md#create_invitation) | **POST** /api/v1/organizations/{organizationId}/invitations | Invite somebody to an organization
+*InvitationsApi* | [**list_invitations**](docs/InvitationsApi.md#list_invitations) | **GET** /api/v1/organizations/{organizationId}/invitations | List an organization&#39;s invitations
+*JobsApi* | [**get_async_job**](docs/JobsApi.md#get_async_job) | **GET** /api/v1/organizations/{organizationId}/jobs/{jobId} | Get an asynchronous job
+*MembersApi* | [**change_member_role**](docs/MembersApi.md#change_member_role) | **PATCH** /api/v1/organizations/{organizationId}/members/{memberId} | Change a member role
+*MembersApi* | [**get_member**](docs/MembersApi.md#get_member) | **GET** /api/v1/organizations/{organizationId}/members/{memberId} | Get one organization membership
+*MembersApi* | [**list_members**](docs/MembersApi.md#list_members) | **GET** /api/v1/organizations/{organizationId}/members | List an organization&#39;s members
+*MembersApi* | [**reactivate_member**](docs/MembersApi.md#reactivate_member) | **POST** /api/v1/organizations/{organizationId}/members/{memberId}/reactivate | Reactivate a suspended member
+*MembersApi* | [**suspend_member**](docs/MembersApi.md#suspend_member) | **POST** /api/v1/organizations/{organizationId}/members/{memberId}/suspend | Suspend a member
+*OrganizationOperationsApi* | [**preview_organization_operation**](docs/OrganizationOperationsApi.md#preview_organization_operation) | **POST** /api/v1/organization-operation-previews | Preview an organization operation and obtain a confirmation
+*OrganizationsApi* | [**archive_organization**](docs/OrganizationsApi.md#archive_organization) | **POST** /api/v1/organizations/{organizationId}/archive | Archive an organization
+*OrganizationsApi* | [**count_organization_tracked_queries**](docs/OrganizationsApi.md#count_organization_tracked_queries) | **GET** /api/v1/organizations/{organizationId}/usage/tracked-queries | Count the tracked queries an organization has configured
+*OrganizationsApi* | [**create_organization**](docs/OrganizationsApi.md#create_organization) | **POST** /api/v1/organizations | Create an organization
+*OrganizationsApi* | [**get_entitlements**](docs/OrganizationsApi.md#get_entitlements) | **GET** /api/v1/organizations/{organizationId}/entitlements | Get an organization&#39;s plan allowance and consumption
+*OrganizationsApi* | [**get_membership_stats**](docs/OrganizationsApi.md#get_membership_stats) | **GET** /api/v1/organizations/{organizationId}/membership-stats | Membership, project and invitation counts for an organization
+*OrganizationsApi* | [**get_organization**](docs/OrganizationsApi.md#get_organization) | **GET** /api/v1/organizations/{organizationId} | Get an organization
+*OrganizationsApi* | [**get_organization_projected_monthly_checks**](docs/OrganizationsApi.md#get_organization_projected_monthly_checks) | **GET** /api/v1/organizations/{organizationId}/usage/projected-monthly-checks | Project a month of check consumption from the current tracking configuration
+*OrganizationsApi* | [**get_organization_stats**](docs/OrganizationsApi.md#get_organization_stats) | **GET** /api/v1/organizations/{organizationId}/stats | Headline counts for an organization
+*OrganizationsApi* | [**list_organizations**](docs/OrganizationsApi.md#list_organizations) | **GET** /api/v1/organizations | List accessible organizations
+*OrganizationsApi* | [**restore_organization**](docs/OrganizationsApi.md#restore_organization) | **POST** /api/v1/organizations/{organizationId}/restore | Restore an archived organization
+*OrganizationsApi* | [**update_organization**](docs/OrganizationsApi.md#update_organization) | **PATCH** /api/v1/organizations/{organizationId} | Update an organization profile
+*ProjectsApi* | [**archive_project**](docs/ProjectsApi.md#archive_project) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/archive | Archive a project
+*ProjectsApi* | [**create_competitor**](docs/ProjectsApi.md#create_competitor) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors | Add a competitor to a project
+*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /api/v1/organizations/{organizationId}/projects | Create a project and the brand monitoring profile its checks run against
+*ProjectsApi* | [**delete_competitor**](docs/ProjectsApi.md#delete_competitor) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId} | Remove a competitor from a project
+*ProjectsApi* | [**get_brand_profile**](docs/ProjectsApi.md#get_brand_profile) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/brand-profile | Get a project&#39;s brand monitoring profile
+*ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId} | Get a project and its brand monitoring configuration
+*ProjectsApi* | [**list_competitors**](docs/ProjectsApi.md#list_competitors) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors | List the competitors tracked by a project
+*ProjectsApi* | [**list_projects**](docs/ProjectsApi.md#list_projects) | **GET** /api/v1/organizations/{organizationId}/projects | List an organization&#39;s projects
+*ProjectsApi* | [**list_query_clusters**](docs/ProjectsApi.md#list_query_clusters) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters | List the keyword clusters of a project
+*ProjectsApi* | [**restore_project**](docs/ProjectsApi.md#restore_project) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/restore | Restore an archived project
+*ProjectsApi* | [**update_competitor**](docs/ProjectsApi.md#update_competitor) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId} | Replace a competitor
+*ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PATCH** /api/v1/organizations/{organizationId}/projects/{projectId} | Rename a project
+*ProjectsApi* | [**update_project_brand_profile**](docs/ProjectsApi.md#update_project_brand_profile) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/brand-profile | Replace a project&#39;s brand monitoring profile
+*TrackedQueriesApi* | [**add_clusters_to_tracked_query**](docs/TrackedQueriesApi.md#add_clusters_to_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/clusters | Add a tracked query to clusters
+*TrackedQueriesApi* | [**batch_change_tracked_queries_check_frequency**](docs/TrackedQueriesApi.md#batch_change_tracked_queries_check_frequency) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/check-frequency | Change how often several tracked queries are checked
+*TrackedQueriesApi* | [**batch_change_tracked_queries_n_passes**](docs/TrackedQueriesApi.md#batch_change_tracked_queries_n_passes) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/passes | Change how many passes several tracked queries run per check
+*TrackedQueriesApi* | [**batch_create_tracked_queries**](docs/TrackedQueriesApi.md#batch_create_tracked_queries) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries | Create tracked queries
+*TrackedQueriesApi* | [**batch_force_check_tracked_queries**](docs/TrackedQueriesApi.md#batch_force_check_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/check | Check several tracked queries now
+*TrackedQueriesApi* | [**batch_pause_tracked_queries**](docs/TrackedQueriesApi.md#batch_pause_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/pause | Pause several tracked queries
+*TrackedQueriesApi* | [**batch_resume_tracked_queries**](docs/TrackedQueriesApi.md#batch_resume_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/resume | Resume several tracked queries
+*TrackedQueriesApi* | [**bulk_add_clusters_to_tracked_queries**](docs/TrackedQueriesApi.md#bulk_add_clusters_to_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk/clusters | Add many tracked queries to clusters
+*TrackedQueriesApi* | [**bulk_delete_tracked_queries**](docs/TrackedQueriesApi.md#bulk_delete_tracked_queries) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk-delete | Delete tracked queries
+*TrackedQueriesApi* | [**bulk_remove_clusters_from_tracked_queries**](docs/TrackedQueriesApi.md#bulk_remove_clusters_from_tracked_queries) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk/clusters | Remove many tracked queries from clusters
+*TrackedQueriesApi* | [**change_tracked_query_check_frequency**](docs/TrackedQueriesApi.md#change_tracked_query_check_frequency) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/check-frequency | Change how often a tracked query is checked
+*TrackedQueriesApi* | [**change_tracked_query_n_passes**](docs/TrackedQueriesApi.md#change_tracked_query_n_passes) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/passes | Change how many passes a tracked query runs per check
+*TrackedQueriesApi* | [**count_tracked_queries**](docs/TrackedQueriesApi.md#count_tracked_queries) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/count | Count a project&#39;s tracked queries and price checking them
+*TrackedQueriesApi* | [**force_check_all_active_tracked_queries**](docs/TrackedQueriesApi.md#force_check_all_active_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/check-all | Check every eligible tracked query of a project now
+*TrackedQueriesApi* | [**get_tracked_query**](docs/TrackedQueriesApi.md#get_tracked_query) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId} | Get a tracked query
+*TrackedQueriesApi* | [**pause_tracked_query**](docs/TrackedQueriesApi.md#pause_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/pause | Pause a tracked query
+*TrackedQueriesApi* | [**remove_clusters_from_tracked_query**](docs/TrackedQueriesApi.md#remove_clusters_from_tracked_query) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/clusters | Remove a tracked query from clusters
+*TrackedQueriesApi* | [**report_ai_response**](docs/TrackedQueriesApi.md#report_ai_response) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/responses/{aiResponseId}/report | Report a problem with a captured AI answer
+*TrackedQueriesApi* | [**resume_tracked_query**](docs/TrackedQueriesApi.md#resume_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/resume | Resume a tracked query
+*TrackedQueriesApi* | [**search_tracked_queries**](docs/TrackedQueriesApi.md#search_tracked_queries) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries | Search a project&#39;s tracked queries
+
+
+## Documentation For Models
+
+ - [AcceptedJobResource](docs/AcceptedJobResource.md)
+ - [AiResponseReportResource](docs/AiResponseReportResource.md)
+ - [AiResponseResource](docs/AiResponseResource.md)
+ - [ApplyClusteringJobOutcome](docs/ApplyClusteringJobOutcome.md)
+ - [ApplyClusteringJobOutcomeClustersInner](docs/ApplyClusteringJobOutcomeClustersInner.md)
+ - [ApplyClusteringJobOutcomeFailedInner](docs/ApplyClusteringJobOutcomeFailedInner.md)
+ - [ApplyClusteringJobOutcomeSkippedClustersInner](docs/ApplyClusteringJobOutcomeSkippedClustersInner.md)
+ - [ApplyClusteringJobOutcomeSuccessfulInner](docs/ApplyClusteringJobOutcomeSuccessfulInner.md)
+ - [AsyncJobResource](docs/AsyncJobResource.md)
+ - [BatchChangeTrackedQueryCheckFrequencyRequestData](docs/BatchChangeTrackedQueryCheckFrequencyRequestData.md)
+ - [BatchChangeTrackedQueryPassesRequestData](docs/BatchChangeTrackedQueryPassesRequestData.md)
+ - [BatchCreateQueryClustersOutcome](docs/BatchCreateQueryClustersOutcome.md)
+ - [BatchCreateQueryClustersOutcomeFailedInner](docs/BatchCreateQueryClustersOutcomeFailedInner.md)
+ - [BatchCreateQueryClustersOutcomeSuccessfulInner](docs/BatchCreateQueryClustersOutcomeSuccessfulInner.md)
+ - [BatchCreateQueryClustersRequestData](docs/BatchCreateQueryClustersRequestData.md)
+ - [BatchCreateTrackedQueriesRequestData](docs/BatchCreateTrackedQueriesRequestData.md)
+ - [BatchCreateTrackedQueriesResultResource](docs/BatchCreateTrackedQueriesResultResource.md)
+ - [BatchCreateTrackedQueriesResultResourceFailedInner](docs/BatchCreateTrackedQueriesResultResourceFailedInner.md)
+ - [BatchCreateTrackedQueriesResultResourceSuccessfulInner](docs/BatchCreateTrackedQueriesResultResourceSuccessfulInner.md)
+ - [BatchForceCheckTrackedQueries200Response](docs/BatchForceCheckTrackedQueries200Response.md)
+ - [BatchForceCheckTrackedQueries200ResponseFailedInner](docs/BatchForceCheckTrackedQueries200ResponseFailedInner.md)
+ - [BatchPauseTrackedQueries200Response](docs/BatchPauseTrackedQueries200Response.md)
+ - [BatchPauseTrackedQueries200ResponseFailedInner](docs/BatchPauseTrackedQueries200ResponseFailedInner.md)
+ - [BatchPauseTrackedQueries200ResponseSuccessfulInner](docs/BatchPauseTrackedQueries200ResponseSuccessfulInner.md)
+ - [BatchResumeTrackedQueries200Response](docs/BatchResumeTrackedQueries200Response.md)
+ - [BatchTargetsRequestData](docs/BatchTargetsRequestData.md)
+ - [BatchWriteOutcome](docs/BatchWriteOutcome.md)
+ - [BatchWriteOutcomeFailedInner](docs/BatchWriteOutcomeFailedInner.md)
+ - [BrandProfileResource](docs/BrandProfileResource.md)
+ - [BulkAddClustersToTrackedQueries200Response](docs/BulkAddClustersToTrackedQueries200Response.md)
+ - [BulkAddClustersToTrackedQueriesRequest](docs/BulkAddClustersToTrackedQueriesRequest.md)
+ - [BulkRemoveClustersFromTrackedQueries200Response](docs/BulkRemoveClustersFromTrackedQueries200Response.md)
+ - [BulkRemoveClustersFromTrackedQueriesRequest](docs/BulkRemoveClustersFromTrackedQueriesRequest.md)
+ - [ChangeMemberRoleRequest](docs/ChangeMemberRoleRequest.md)
+ - [ChangeTrackedQueryCheckFrequencyRequestData](docs/ChangeTrackedQueryCheckFrequencyRequestData.md)
+ - [ChangeTrackedQueryPassesRequestData](docs/ChangeTrackedQueryPassesRequestData.md)
+ - [CitationResource](docs/CitationResource.md)
+ - [ClusterMembershipRequestData](docs/ClusterMembershipRequestData.md)
+ - [CompetitorResource](docs/CompetitorResource.md)
+ - [CreateCompetitorRequest](docs/CreateCompetitorRequest.md)
+ - [CreateInvitation200Response](docs/CreateInvitation200Response.md)
+ - [CreateInvitation201Response](docs/CreateInvitation201Response.md)
+ - [CreateInvitationRequest](docs/CreateInvitationRequest.md)
+ - [CreateOrganization201Response](docs/CreateOrganization201Response.md)
+ - [CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
+ - [CreateProjectRequest](docs/CreateProjectRequest.md)
+ - [CreateProjectRequestCompetitorsInner](docs/CreateProjectRequestCompetitorsInner.md)
+ - [CreateQueryCluster409Response](docs/CreateQueryCluster409Response.md)
+ - [CreateQueryClusterRequest](docs/CreateQueryClusterRequest.md)
+ - [DeleteQueryCluster200Response](docs/DeleteQueryCluster200Response.md)
+ - [EntitlementsResource](docs/EntitlementsResource.md)
+ - [GetAvailableFilters200Response](docs/GetAvailableFilters200Response.md)
+ - [GetAvailableFilters200ResponseClustersInner](docs/GetAvailableFilters200ResponseClustersInner.md)
+ - [GetMeStats200Response](docs/GetMeStats200Response.md)
+ - [GetMeStats200ResponseOrganizations](docs/GetMeStats200ResponseOrganizations.md)
+ - [GetMeStats200ResponseProjects](docs/GetMeStats200ResponseProjects.md)
+ - [GetMembershipStats200Response](docs/GetMembershipStats200Response.md)
+ - [GetMentionSamples400Response](docs/GetMentionSamples400Response.md)
+ - [GetMentionSamples400ResponseDetailsValueInner](docs/GetMentionSamples400ResponseDetailsValueInner.md)
+ - [GetMetricGlossary200Response](docs/GetMetricGlossary200Response.md)
+ - [GetMetricGlossary200ResponseMetricsInner](docs/GetMetricGlossary200ResponseMetricsInner.md)
+ - [GetOrganizationOverview200Response](docs/GetOrganizationOverview200Response.md)
+ - [GetOrganizationOverview200ResponseAggregate](docs/GetOrganizationOverview200ResponseAggregate.md)
+ - [GetOrganizationOverview200ResponseProjectsInner](docs/GetOrganizationOverview200ResponseProjectsInner.md)
+ - [GetOrganizationStats200Response](docs/GetOrganizationStats200Response.md)
+ - [GetOrganizationStats200ResponseInvitations](docs/GetOrganizationStats200ResponseInvitations.md)
+ - [GetOrganizationStats200ResponseMembers](docs/GetOrganizationStats200ResponseMembers.md)
+ - [GetOrganizationStats200ResponseProjects](docs/GetOrganizationStats200ResponseProjects.md)
+ - [GetShareOfVoiceFormula200Response](docs/GetShareOfVoiceFormula200Response.md)
+ - [GetTrackingCoverage200Response](docs/GetTrackingCoverage200Response.md)
+ - [GetTrackingCoverage200ResponseSampleInner](docs/GetTrackingCoverage200ResponseSampleInner.md)
+ - [InvitationResource](docs/InvitationResource.md)
+ - [KeywordListingResource](docs/KeywordListingResource.md)
+ - [KeywordListingResourceMentionTypeCounts](docs/KeywordListingResourceMentionTypeCounts.md)
+ - [ListAiResponses200Response](docs/ListAiResponses200Response.md)
+ - [ListCompetitors200Response](docs/ListCompetitors200Response.md)
+ - [ListInvitations200Response](docs/ListInvitations200Response.md)
+ - [ListKeywordListings200Response](docs/ListKeywordListings200Response.md)
+ - [ListMembers200Response](docs/ListMembers200Response.md)
+ - [ListOrganizations200Response](docs/ListOrganizations200Response.md)
+ - [ListProjects200Response](docs/ListProjects200Response.md)
+ - [ListQueryClusters200Response](docs/ListQueryClusters200Response.md)
+ - [ListSearchSnapshots200Response](docs/ListSearchSnapshots200Response.md)
+ - [ListShoppingSnapshots200Response](docs/ListShoppingSnapshots200Response.md)
+ - [MeResource](docs/MeResource.md)
+ - [MemberResource](docs/MemberResource.md)
+ - [OperationEffect](docs/OperationEffect.md)
+ - [OrganizationResource](docs/OrganizationResource.md)
+ - [PreviewOrganizationOperation200Response](docs/PreviewOrganizationOperation200Response.md)
+ - [PreviewOrganizationOperation200ResponseOrganization](docs/PreviewOrganizationOperation200ResponseOrganization.md)
+ - [PreviewOrganizationOperationRequest](docs/PreviewOrganizationOperationRequest.md)
+ - [ProjectDetailResource](docs/ProjectDetailResource.md)
+ - [ProjectDetailResourceCompetitorsInner](docs/ProjectDetailResourceCompetitorsInner.md)
+ - [ProjectResource](docs/ProjectResource.md)
+ - [ProjectedMonthlyChecksResource](docs/ProjectedMonthlyChecksResource.md)
+ - [QueryClusterResource](docs/QueryClusterResource.md)
+ - [ReportAiResponseRequest](docs/ReportAiResponseRequest.md)
+ - [SearchResultResource](docs/SearchResultResource.md)
+ - [SearchSnapshotResource](docs/SearchSnapshotResource.md)
+ - [SearchTrackedQueries200Response](docs/SearchTrackedQueries200Response.md)
+ - [ShoppingOfferResource](docs/ShoppingOfferResource.md)
+ - [ShoppingSnapshotResource](docs/ShoppingSnapshotResource.md)
+ - [StartBrandDiscoveryJobRequest](docs/StartBrandDiscoveryJobRequest.md)
+ - [StartBrandNameSuggestionJobRequest](docs/StartBrandNameSuggestionJobRequest.md)
+ - [StartClusteringJobRequestData](docs/StartClusteringJobRequestData.md)
+ - [StartKeywordDiscoveryJobRequest](docs/StartKeywordDiscoveryJobRequest.md)
+ - [StartPromptDiscoveryJobRequest](docs/StartPromptDiscoveryJobRequest.md)
+ - [SubmittedChecksResource](docs/SubmittedChecksResource.md)
+ - [SubscriptionResource](docs/SubscriptionResource.md)
+ - [TrackedQueryCountResource](docs/TrackedQueryCountResource.md)
+ - [TrackedQueryDetailResource](docs/TrackedQueryDetailResource.md)
+ - [TrackedQueryResource](docs/TrackedQueryResource.md)
+ - [TrackedQueryUsageResource](docs/TrackedQueryUsageResource.md)
+ - [UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
+ - [UpdateProjectBrandProfileRequest](docs/UpdateProjectBrandProfileRequest.md)
+ - [UpdateProjectRequest](docs/UpdateProjectRequest.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="ApiKey"></a>
+### ApiKey
+
+- **Type**: Bearer authentication
+
+
+## Author
+
+support@mencoro.com
+
+