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 project:

• API version: 1.0.0
• Package version: 1.0.1
• Generator version: 7.24.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit 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:

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:

import mencoro

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 mencoro

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

• AcceptedJobResource
• AiResponseReportResource
• AiResponseResource
• ApplyClusteringJobOutcome
• ApplyClusteringJobOutcomeClustersInner
• ApplyClusteringJobOutcomeFailedInner
• ApplyClusteringJobOutcomeSkippedClustersInner
• ApplyClusteringJobOutcomeSuccessfulInner
• AsyncJobResource
• BatchChangeTrackedQueryCheckFrequencyRequestData
• BatchChangeTrackedQueryPassesRequestData
• BatchCreateQueryClustersOutcome
• BatchCreateQueryClustersOutcomeFailedInner
• BatchCreateQueryClustersOutcomeSuccessfulInner
• BatchCreateQueryClustersRequestData
• BatchCreateTrackedQueriesRequestData
• BatchCreateTrackedQueriesResultResource
• BatchCreateTrackedQueriesResultResourceFailedInner
• BatchCreateTrackedQueriesResultResourceSuccessfulInner
• BatchForceCheckTrackedQueries200Response
• BatchForceCheckTrackedQueries200ResponseFailedInner
• BatchPauseTrackedQueries200Response
• BatchPauseTrackedQueries200ResponseFailedInner
• BatchPauseTrackedQueries200ResponseSuccessfulInner
• BatchResumeTrackedQueries200Response
• BatchTargetsRequestData
• BatchWriteOutcome
• BatchWriteOutcomeFailedInner
• BrandProfileResource
• BulkAddClustersToTrackedQueries200Response
• BulkAddClustersToTrackedQueriesRequest
• BulkRemoveClustersFromTrackedQueries200Response
• BulkRemoveClustersFromTrackedQueriesRequest
• ChangeMemberRoleRequest
• ChangeTrackedQueryCheckFrequencyRequestData
• ChangeTrackedQueryPassesRequestData
• CitationResource
• ClusterMembershipRequestData
• CompetitorResource
• CreateCompetitorRequest
• CreateInvitation200Response
• CreateInvitation201Response
• CreateInvitationRequest
• CreateOrganization201Response
• CreateOrganizationRequest
• CreateProjectRequest
• CreateProjectRequestCompetitorsInner
• CreateQueryCluster409Response
• CreateQueryClusterRequest
• DeleteQueryCluster200Response
• EntitlementsResource
• GetAvailableFilters200Response
• GetAvailableFilters200ResponseClustersInner
• GetMeStats200Response
• GetMeStats200ResponseOrganizations
• GetMeStats200ResponseProjects
• GetMembershipStats200Response
• GetMentionSamples400Response
• GetMentionSamples400ResponseDetailsValueInner
• GetMetricGlossary200Response
• GetMetricGlossary200ResponseMetricsInner
• GetOrganizationOverview200Response
• GetOrganizationOverview200ResponseAggregate
• GetOrganizationOverview200ResponseProjectsInner
• GetOrganizationStats200Response
• GetOrganizationStats200ResponseInvitations
• GetOrganizationStats200ResponseMembers
• GetOrganizationStats200ResponseProjects
• GetShareOfVoiceFormula200Response
• GetTrackingCoverage200Response
• GetTrackingCoverage200ResponseSampleInner
• InvitationResource
• KeywordListingResource
• KeywordListingResourceMentionTypeCounts
• ListAiResponses200Response
• ListCompetitors200Response
• ListInvitations200Response
• ListKeywordListings200Response
• ListMembers200Response
• ListOrganizations200Response
• ListProjects200Response
• ListQueryClusters200Response
• ListSearchSnapshots200Response
• ListShoppingSnapshots200Response
• MeResource
• MemberResource
• OperationEffect
• OrganizationResource
• PreviewOrganizationOperation200Response
• PreviewOrganizationOperation200ResponseOrganization
• PreviewOrganizationOperationRequest
• ProjectDetailResource
• ProjectDetailResourceCompetitorsInner
• ProjectResource
• ProjectedMonthlyChecksResource
• QueryClusterResource
• ReportAiResponseRequest
• SearchResultResource
• SearchSnapshotResource
• SearchTrackedQueries200Response
• ShoppingOfferResource
• ShoppingSnapshotResource
• StartBrandDiscoveryJobRequest
• StartBrandNameSuggestionJobRequest
• StartClusteringJobRequestData
• StartKeywordDiscoveryJobRequest
• StartPromptDiscoveryJobRequest
• SubmittedChecksResource
• SubscriptionResource
• TrackedQueryCountResource
• TrackedQueryDetailResource
• TrackedQueryResource
• TrackedQueryUsageResource
• UpdateOrganizationRequest
• UpdateProjectBrandProfileRequest
• UpdateProjectRequest

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

• Type: Bearer authentication

Author

support@mencoro.com