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.0
  • 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

Class Method HTTP request Description
AccountApi get_me GET /api/v1/me Get the authenticated identity
AccountApi get_me_stats GET /api/v1/me/stats Counts across everything the key can reach
AnalyticsApi get_available_filters GET /api/v1/organizations/{organizationId}/projects/{projectId}/available-filters Filter values a project is configured for
AnalyticsApi get_cited_sources GET /api/v1/organizations/{organizationId}/projects/{projectId}/cited-sources Domains and pages the AI answers cited
AnalyticsApi get_cluster_breakdown GET /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/clusters Rank-tracking metrics per keyword cluster
AnalyticsApi 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 GET /api/v1/organizations/{organizationId}/projects/{projectId}/mentions/mix Composition of a project brand mentions in AI answers
AnalyticsApi 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 GET /api/v1/metric-glossary Map everyday wording to a metric and the operation that serves it
AnalyticsApi get_organization_overview GET /api/v1/organizations/{organizationId}/overview Snapshot rank-health board across an organization active projects
AnalyticsApi get_project_metrics GET /api/v1/organizations/{organizationId}/projects/{projectId}/metrics Headline visibility metrics of a project
AnalyticsApi get_project_sentiment GET /api/v1/organizations/{organizationId}/projects/{projectId}/sentiment Sentiment breakdown of a project brand mentions
AnalyticsApi get_project_time_series GET /api/v1/organizations/{organizationId}/projects/{projectId}/timeseries Rank-tracking metrics of a project over time
AnalyticsApi 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 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 GET /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/timeseries Rank-tracking time series of a single tracked query
AnalyticsApi get_tracking_coverage GET /api/v1/organizations/{organizationId}/projects/{projectId}/coverage Coverage and staleness of a project tracked queries
AnalyticsApi list_keyword_listings GET /api/v1/organizations/{organizationId}/projects/{projectId}/keyword-listings List a project's keywords with their windowed metrics
BillingApi get_subscription GET /api/v1/organizations/{organizationId}/subscription Get the subscription of an organization
CapturesApi list_ai_responses GET /api/v1/organizations/{organizationId}/projects/{projectId}/ai-responses List captured AI answers
CapturesApi list_search_snapshots GET /api/v1/organizations/{organizationId}/projects/{projectId}/search-snapshots List captured search-results pages
CapturesApi list_shopping_snapshots GET /api/v1/organizations/{organizationId}/projects/{projectId}/shopping-snapshots List captured shopping-results pages
ClustersApi 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 POST /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/batch Create several keyword clusters at once
ClustersApi create_query_cluster POST /api/v1/organizations/{organizationId}/projects/{projectId}/clusters Create a keyword cluster
ClustersApi delete_query_cluster DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} Delete a keyword cluster
ClustersApi rename_query_cluster PATCH /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} Rename a keyword cluster
ClustersApi start_clustering_job POST /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/jobs Start a keyword clustering job
DiscoveryApi 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 POST /api/v1/organizations/{organizationId}/brand-name-suggestions Start a brand-name alias suggestion job
DiscoveryApi 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 POST /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/prompts Start a geo prompt discovery job for a project
InvitationsApi cancel_invitation POST /api/v1/organizations/{organizationId}/invitations/{invitationId}/cancel Cancel a pending invitation
InvitationsApi create_invitation POST /api/v1/organizations/{organizationId}/invitations Invite somebody to an organization
InvitationsApi list_invitations GET /api/v1/organizations/{organizationId}/invitations List an organization's invitations
JobsApi get_async_job GET /api/v1/organizations/{organizationId}/jobs/{jobId} Get an asynchronous job
MembersApi change_member_role PATCH /api/v1/organizations/{organizationId}/members/{memberId} Change a member role
MembersApi get_member GET /api/v1/organizations/{organizationId}/members/{memberId} Get one organization membership
MembersApi list_members GET /api/v1/organizations/{organizationId}/members List an organization's members
MembersApi reactivate_member POST /api/v1/organizations/{organizationId}/members/{memberId}/reactivate Reactivate a suspended member
MembersApi suspend_member POST /api/v1/organizations/{organizationId}/members/{memberId}/suspend Suspend a member
OrganizationOperationsApi preview_organization_operation POST /api/v1/organization-operation-previews Preview an organization operation and obtain a confirmation
OrganizationsApi archive_organization POST /api/v1/organizations/{organizationId}/archive Archive an organization
OrganizationsApi count_organization_tracked_queries GET /api/v1/organizations/{organizationId}/usage/tracked-queries Count the tracked queries an organization has configured
OrganizationsApi create_organization POST /api/v1/organizations Create an organization
OrganizationsApi get_entitlements GET /api/v1/organizations/{organizationId}/entitlements Get an organization's plan allowance and consumption
OrganizationsApi get_membership_stats GET /api/v1/organizations/{organizationId}/membership-stats Membership, project and invitation counts for an organization
OrganizationsApi get_organization GET /api/v1/organizations/{organizationId} Get an organization
OrganizationsApi 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 GET /api/v1/organizations/{organizationId}/stats Headline counts for an organization
OrganizationsApi list_organizations GET /api/v1/organizations List accessible organizations
OrganizationsApi restore_organization POST /api/v1/organizations/{organizationId}/restore Restore an archived organization
OrganizationsApi update_organization PATCH /api/v1/organizations/{organizationId} Update an organization profile
ProjectsApi archive_project POST /api/v1/organizations/{organizationId}/projects/{projectId}/archive Archive a project
ProjectsApi create_competitor POST /api/v1/organizations/{organizationId}/projects/{projectId}/competitors Add a competitor to a project
ProjectsApi create_project POST /api/v1/organizations/{organizationId}/projects Create a project and the brand monitoring profile its checks run against
ProjectsApi delete_competitor DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId} Remove a competitor from a project
ProjectsApi get_brand_profile GET /api/v1/organizations/{organizationId}/projects/{projectId}/brand-profile Get a project's brand monitoring profile
ProjectsApi get_project GET /api/v1/organizations/{organizationId}/projects/{projectId} Get a project and its brand monitoring configuration
ProjectsApi list_competitors GET /api/v1/organizations/{organizationId}/projects/{projectId}/competitors List the competitors tracked by a project
ProjectsApi list_projects GET /api/v1/organizations/{organizationId}/projects List an organization's projects
ProjectsApi list_query_clusters GET /api/v1/organizations/{organizationId}/projects/{projectId}/clusters List the keyword clusters of a project
ProjectsApi restore_project POST /api/v1/organizations/{organizationId}/projects/{projectId}/restore Restore an archived project
ProjectsApi update_competitor PUT /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId} Replace a competitor
ProjectsApi update_project PATCH /api/v1/organizations/{organizationId}/projects/{projectId} Rename a project
ProjectsApi update_project_brand_profile PUT /api/v1/organizations/{organizationId}/projects/{projectId}/brand-profile Replace a project's brand monitoring profile
TrackedQueriesApi 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 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 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 POST /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries Create tracked queries
TrackedQueriesApi 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 PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/pause Pause several tracked queries
TrackedQueriesApi 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 PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk/clusters Add many tracked queries to clusters
TrackedQueriesApi 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 DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk/clusters Remove many tracked queries from clusters
TrackedQueriesApi 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 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 GET /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/count Count a project's tracked queries and price checking them
TrackedQueriesApi 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 GET /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId} Get a tracked query
TrackedQueriesApi pause_tracked_query PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/pause Pause a tracked query
TrackedQueriesApi 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 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 PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/resume Resume a tracked query
TrackedQueriesApi search_tracked_queries GET /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries Search a project's tracked queries

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

  • Type: Bearer authentication

Author

support@mencoro.com

Project links

Data verified by PyPI on Sep 22, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.0.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for marcisw from gravatar.com marcisw

Credits

Author: Mencoro Support

GitHub Statistics

Data verified by PyPI on Sep 22, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Proprietary

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Mencoro API

Report project as malware

Release files for mencoro 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mencoro 1.0.0
File Size Uploaded
mencoro-1.0.0.tar.gz 162.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mencoro 1.0.0
File Interpreter ABI Platform
mencoro-1.0.0-py3-none-any.whl 303.3 kB Python 3 none any Details

Total release size: 465.4 kB

Release files / mencoro-1.0.0.tar.gz

Download URL mencoro-1.0.0.tar.gz
Size 162.1 kB
Tags Source
SHA-256 checksum
How to use checksums 		2cfe24864bbdc5a67194b7a638fc4311b4527c047a2102fbe55c1e6473f30d7e
BLAKE2b-256 checksum
How to use checksums 		0992b77a79e7fc55846aa3ea3bb1f9b8951b7f5f2f666f1894662ec7f171b7b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/mencoro/mencoro-api-sdk
Publishing commit
github.com/mencoro/mencoro-api-sdk/tree/1c2c7cd42ec71361aa124a28f38d392989afe558
Workflow
Publishing configuration
github.com/mencoro/mencoro-api-sdk/blob/1c2c7cd42ec71361aa124a28f38d392989afe558/.github/workflows/release.yml
Publishing logs
github.com/mencoro/mencoro-api-sdk/actions/runs/35742221325/attempts/1
Artifact
Subject
mencoro-1.0.0.tar.gz
SHA-256 checksum
2cfe24864bbdc5a67194b7a638fc4311b4527c047a2102fbe55c1e6473f30d7e Verifying attestations

Release files / mencoro-1.0.0-py3-none-any.whl

Download URL mencoro-1.0.0-py3-none-any.whl
Size 303.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		e23235305168895a3b39061a815d1071a6b73d4c9ddcccbe343d9832b1a7f809
BLAKE2b-256 checksum
How to use checksums 		f09de591ed602e7940f1905591d091c59d5c93f7bb1ce3f9cb7e70cddcad236f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/mencoro/mencoro-api-sdk
Publishing commit
github.com/mencoro/mencoro-api-sdk/tree/1c2c7cd42ec71361aa124a28f38d392989afe558
Workflow
Publishing configuration
github.com/mencoro/mencoro-api-sdk/blob/1c2c7cd42ec71361aa124a28f38d392989afe558/.github/workflows/release.yml
Publishing logs
github.com/mencoro/mencoro-api-sdk/actions/runs/35742221325/attempts/1
Artifact
Subject
mencoro-1.0.0-py3-none-any.whl
SHA-256 checksum
e23235305168895a3b39061a815d1071a6b73d4c9ddcccbe343d9832b1a7f809 Verifying attestations

Release history Release notifications | RSS feed

1.0.1

2 release files

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page