@mencoro/api

@mencoro/api@1.0.0

A TypeScript SDK client for the api.mencoro.com API.

Usage

First, install the SDK from npm.

npm install @mencoro/api --save

Next, try it out.

import {
  Configuration,
  AccountApi,
} from '@mencoro/api';
import type { GetMeRequest } from '@mencoro/api';

async function example() {
  console.log("🚀 Testing @mencoro/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: ApiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AccountApi(config);

  try {
    const data = await api.getMe();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://api.mencoro.com

Class	Method	HTTP request	Description
AccountApi	getMe	GET /api/v1/me	Get the authenticated identity
AccountApi	getMeStats	GET /api/v1/me/stats	Counts across everything the key can reach
AnalyticsApi	getAvailableFilters	GET /api/v1/organizations/{organizationId}/projects/{projectId}/available-filters	Filter values a project is configured for
AnalyticsApi	getCitedSources	GET /api/v1/organizations/{organizationId}/projects/{projectId}/cited-sources	Domains and pages the AI answers cited
AnalyticsApi	getClusterBreakdown	GET /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/clusters	Rank-tracking metrics per keyword cluster
AnalyticsApi	getCompetitorCoOccurrence	GET /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/co-occurrence	Head-to-head record of the brand against each tracked competitor
AnalyticsApi	getMentionMix	GET /api/v1/organizations/{organizationId}/projects/{projectId}/mentions/mix	Composition of a project brand mentions in AI answers
AnalyticsApi	getMentionSamples	GET /api/v1/organizations/{organizationId}/projects/{projectId}/mentions	Sample of the raw AI mention texts of a project
AnalyticsApi	getMetricGlossary	GET /api/v1/metric-glossary	Map everyday wording to a metric and the operation that serves it
AnalyticsApi	getOrganizationOverview	GET /api/v1/organizations/{organizationId}/overview	Snapshot rank-health board across an organization active projects
AnalyticsApi	getProjectMetrics	GET /api/v1/organizations/{organizationId}/projects/{projectId}/metrics	Headline visibility metrics of a project
AnalyticsApi	getProjectSentiment	GET /api/v1/organizations/{organizationId}/projects/{projectId}/sentiment	Sentiment breakdown of a project brand mentions
AnalyticsApi	getProjectTimeSeries	GET /api/v1/organizations/{organizationId}/projects/{projectId}/timeseries	Rank-tracking metrics of a project over time
AnalyticsApi	getQueryMovers	GET /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/movers	Tracked queries ranked by how much a metric moved
AnalyticsApi	getShareOfVoiceFormula	GET /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/share-of-voice-formula	The constants behind the Share of Voice score
AnalyticsApi	getTrackedQueryTimeSeries	GET /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/timeseries	Rank-tracking time series of a single tracked query
AnalyticsApi	getTrackingCoverage	GET /api/v1/organizations/{organizationId}/projects/{projectId}/coverage	Coverage and staleness of a project tracked queries
AnalyticsApi	listKeywordListings	GET /api/v1/organizations/{organizationId}/projects/{projectId}/keyword-listings	List a project's keywords with their windowed metrics
BillingApi	getSubscription	GET /api/v1/organizations/{organizationId}/subscription	Get the subscription of an organization
CapturesApi	listAiResponses	GET /api/v1/organizations/{organizationId}/projects/{projectId}/ai-responses	List captured AI answers
CapturesApi	listSearchSnapshots	GET /api/v1/organizations/{organizationId}/projects/{projectId}/search-snapshots	List captured search-results pages
CapturesApi	listShoppingSnapshots	GET /api/v1/organizations/{organizationId}/projects/{projectId}/shopping-snapshots	List captured shopping-results pages
ClustersApi	applyClusteringJob	POST /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/jobs/{jobId}/apply	Apply the result of a clustering job
ClustersApi	batchCreateQueryClusters	POST /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/batch	Create several keyword clusters at once
ClustersApi	createQueryCluster	POST /api/v1/organizations/{organizationId}/projects/{projectId}/clusters	Create a keyword cluster
ClustersApi	deleteQueryCluster	DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}	Delete a keyword cluster
ClustersApi	renameQueryCluster	PATCH /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}	Rename a keyword cluster
ClustersApi	startClusteringJob	POST /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/jobs	Start a keyword clustering job
DiscoveryApi	startBrandDiscoveryJob	POST /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/brands	Start a brand discovery job for a project
DiscoveryApi	startBrandNameSuggestionJob	POST /api/v1/organizations/{organizationId}/brand-name-suggestions	Start a brand-name alias suggestion job
DiscoveryApi	startKeywordDiscoveryJob	POST /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/keywords	Start a keyword discovery job for a project
DiscoveryApi	startPromptDiscoveryJob	POST /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/prompts	Start a geo prompt discovery job for a project
InvitationsApi	cancelInvitation	POST /api/v1/organizations/{organizationId}/invitations/{invitationId}/cancel	Cancel a pending invitation
InvitationsApi	createInvitation	POST /api/v1/organizations/{organizationId}/invitations	Invite somebody to an organization
InvitationsApi	listInvitations	GET /api/v1/organizations/{organizationId}/invitations	List an organization's invitations
JobsApi	getAsyncJob	GET /api/v1/organizations/{organizationId}/jobs/{jobId}	Get an asynchronous job
MembersApi	changeMemberRole	PATCH /api/v1/organizations/{organizationId}/members/{memberId}	Change a member role
MembersApi	getMember	GET /api/v1/organizations/{organizationId}/members/{memberId}	Get one organization membership
MembersApi	listMembers	GET /api/v1/organizations/{organizationId}/members	List an organization's members
MembersApi	reactivateMember	POST /api/v1/organizations/{organizationId}/members/{memberId}/reactivate	Reactivate a suspended member
MembersApi	suspendMember	POST /api/v1/organizations/{organizationId}/members/{memberId}/suspend	Suspend a member
OrganizationOperationsApi	previewOrganizationOperation	POST /api/v1/organization-operation-previews	Preview an organization operation and obtain a confirmation
OrganizationsApi	archiveOrganization	POST /api/v1/organizations/{organizationId}/archive	Archive an organization
OrganizationsApi	countOrganizationTrackedQueries	GET /api/v1/organizations/{organizationId}/usage/tracked-queries	Count the tracked queries an organization has configured
OrganizationsApi	createOrganization	POST /api/v1/organizations	Create an organization
OrganizationsApi	getEntitlements	GET /api/v1/organizations/{organizationId}/entitlements	Get an organization's plan allowance and consumption
OrganizationsApi	getMembershipStats	GET /api/v1/organizations/{organizationId}/membership-stats	Membership, project and invitation counts for an organization
OrganizationsApi	getOrganization	GET /api/v1/organizations/{organizationId}	Get an organization
OrganizationsApi	getOrganizationProjectedMonthlyChecks	GET /api/v1/organizations/{organizationId}/usage/projected-monthly-checks	Project a month of check consumption from the current tracking configuration
OrganizationsApi	getOrganizationStats	GET /api/v1/organizations/{organizationId}/stats	Headline counts for an organization
OrganizationsApi	listOrganizations	GET /api/v1/organizations	List accessible organizations
OrganizationsApi	restoreOrganization	POST /api/v1/organizations/{organizationId}/restore	Restore an archived organization
OrganizationsApi	updateOrganization	PATCH /api/v1/organizations/{organizationId}	Update an organization profile
ProjectsApi	archiveProject	POST /api/v1/organizations/{organizationId}/projects/{projectId}/archive	Archive a project
ProjectsApi	createCompetitor	POST /api/v1/organizations/{organizationId}/projects/{projectId}/competitors	Add a competitor to a project
ProjectsApi	createProject	POST /api/v1/organizations/{organizationId}/projects	Create a project and the brand monitoring profile its checks run against
ProjectsApi	deleteCompetitor	DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId}	Remove a competitor from a project
ProjectsApi	getBrandProfile	GET /api/v1/organizations/{organizationId}/projects/{projectId}/brand-profile	Get a project's brand monitoring profile
ProjectsApi	getProject	GET /api/v1/organizations/{organizationId}/projects/{projectId}	Get a project and its brand monitoring configuration
ProjectsApi	listCompetitors	GET /api/v1/organizations/{organizationId}/projects/{projectId}/competitors	List the competitors tracked by a project
ProjectsApi	listProjects	GET /api/v1/organizations/{organizationId}/projects	List an organization's projects
ProjectsApi	listQueryClusters	GET /api/v1/organizations/{organizationId}/projects/{projectId}/clusters	List the keyword clusters of a project
ProjectsApi	restoreProject	POST /api/v1/organizations/{organizationId}/projects/{projectId}/restore	Restore an archived project
ProjectsApi	updateCompetitor	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId}	Replace a competitor
ProjectsApi	updateProject	PATCH /api/v1/organizations/{organizationId}/projects/{projectId}	Rename a project
ProjectsApi	updateProjectBrandProfile	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/brand-profile	Replace a project's brand monitoring profile
TrackedQueriesApi	addClustersToTrackedQuery	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/clusters	Add a tracked query to clusters
TrackedQueriesApi	batchChangeTrackedQueriesCheckFrequency	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/check-frequency	Change how often several tracked queries are checked
TrackedQueriesApi	batchChangeTrackedQueriesNPasses	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/passes	Change how many passes several tracked queries run per check
TrackedQueriesApi	batchCreateTrackedQueries	POST /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries	Create tracked queries
TrackedQueriesApi	batchForceCheckTrackedQueries	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/check	Check several tracked queries now
TrackedQueriesApi	batchPauseTrackedQueries	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/pause	Pause several tracked queries
TrackedQueriesApi	batchResumeTrackedQueries	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/resume	Resume several tracked queries
TrackedQueriesApi	bulkAddClustersToTrackedQueries	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk/clusters	Add many tracked queries to clusters
TrackedQueriesApi	bulkDeleteTrackedQueries	POST /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk-delete	Delete tracked queries
TrackedQueriesApi	bulkRemoveClustersFromTrackedQueries	DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk/clusters	Remove many tracked queries from clusters
TrackedQueriesApi	changeTrackedQueryCheckFrequency	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/check-frequency	Change how often a tracked query is checked
TrackedQueriesApi	changeTrackedQueryNPasses	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/passes	Change how many passes a tracked query runs per check
TrackedQueriesApi	countTrackedQueries	GET /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/count	Count a project's tracked queries and price checking them
TrackedQueriesApi	forceCheckAllActiveTrackedQueries	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/check-all	Check every eligible tracked query of a project now
TrackedQueriesApi	getTrackedQuery	GET /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}	Get a tracked query
TrackedQueriesApi	pauseTrackedQuery	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/pause	Pause a tracked query
TrackedQueriesApi	removeClustersFromTrackedQuery	DELETE /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/clusters	Remove a tracked query from clusters
TrackedQueriesApi	reportAiResponse	POST /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/responses/{aiResponseId}/report	Report a problem with a captured AI answer
TrackedQueriesApi	resumeTrackedQuery	PUT /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/resume	Resume a tracked query
TrackedQueriesApi	searchTrackedQueries	GET /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries	Search a project's tracked queries

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

Authorization

Authentication schemes defined for the API:

ApiKey

• Type: HTTP Bearer Token authentication

About

This TypeScript SDK client supports the Fetch API and 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.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

For more information, please visit https://mencoro.com/contact/

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Proprietary