mencoro 1.0.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +41 -5
- data/docs/AccountApi.md +1 -1
- data/docs/AnalyticsApi.md +96 -86
- data/docs/AsyncJobResource.md +3 -1
- data/docs/AsyncJobResourceError.md +20 -0
- data/docs/BillingApi.md +1 -1
- data/docs/CitedSourceRow.md +32 -0
- data/docs/CitedSourcesResponse.md +20 -0
- data/docs/ClusterBreakdownRow.md +82 -0
- data/docs/ClustersApi.md +74 -0
- data/docs/CompetitorCoOccurrenceResponse.md +18 -0
- data/docs/CompetitorCoOccurrenceRow.md +36 -0
- data/docs/CompetitorShareOfVoice.md +20 -0
- data/docs/CreateInvitation201Response.md +4 -0
- data/docs/CreateInvitationRequest.md +3 -1
- data/docs/CreateInvitationRequestProjectAccess.md +20 -0
- data/docs/DiscoveryApi.md +1 -1
- data/docs/GetMeStats200ResponseProjects.md +1 -1
- data/docs/GetOrganizationOverview200ResponseAggregate.md +1 -1
- data/docs/GetOrganizationOverview200ResponseProjectsInner.md +8 -2
- data/docs/GetOrganizationStats200ResponseInvitations.md +1 -1
- data/docs/GetOrganizationStats200ResponseMembers.md +1 -1
- data/docs/GetOrganizationStats200ResponseProjects.md +1 -1
- data/docs/InvitationResource.md +5 -1
- data/docs/JobsApi.md +1 -1
- data/docs/KeywordListingResource.md +12 -10
- data/docs/KeywordListingResourceCarriedPositions.md +24 -0
- data/docs/KeywordListingResourceCarriedPositionsSerp.md +20 -0
- data/docs/ListProjects200Response.md +1 -1
- data/docs/MemberResource.md +5 -1
- data/docs/MembersApi.md +78 -0
- data/docs/MentionMatchResource.md +44 -0
- data/docs/MentionSampleResponse.md +46 -0
- data/docs/MentionTypeCounts.md +26 -0
- data/docs/OrganizationsApi.md +3 -3
- data/docs/PerCompetitorSentiment.md +30 -0
- data/docs/PerEngineSentiment.md +28 -0
- data/docs/PerEntityMetrics.md +32 -0
- data/docs/PositionDistributionBucket.md +20 -0
- data/docs/ProjectMentionMixResponse.md +22 -0
- data/docs/ProjectMentionSamplesResponse.md +20 -0
- data/docs/ProjectRankTrackingClusterBreakdown.md +20 -0
- data/docs/ProjectRankTrackingStats.md +96 -0
- data/docs/ProjectRankTrackingTimeSeries.md +20 -0
- data/docs/ProjectSentimentBreakdown.md +20 -0
- data/docs/ProjectedMonthlyChecksResource.md +2 -2
- data/docs/ProjectsApi.md +76 -2
- data/docs/SearchTrackedQueryMentionMatches200Response.md +20 -0
- data/docs/SearchTrackedQuerySerpMatches200Response.md +20 -0
- data/docs/SerpMatchResource.md +30 -0
- data/docs/SetMemberProjectAccessRequest.md +20 -0
- data/docs/SubscriptionResource.md +1 -1
- data/docs/TimeSeriesPoint.md +22 -0
- data/docs/TrackedQueriesApi.md +175 -3
- data/docs/TrackedQueryCountResource.md +1 -1
- data/docs/TrackedQueryMoverRow.md +58 -0
- data/docs/TrackedQueryMoversResponse.md +22 -0
- data/docs/TrackedQueryRankTrackingTimeSeries.md +20 -0
- data/docs/TrackedQueryUsageResource.md +1 -1
- data/lib/mencoro/api/account_api.rb +3 -3
- data/lib/mencoro/api/analytics_api.rb +103 -85
- data/lib/mencoro/api/billing_api.rb +3 -3
- data/lib/mencoro/api/captures_api.rb +2 -2
- data/lib/mencoro/api/clusters_api.rb +76 -1
- data/lib/mencoro/api/discovery_api.rb +3 -3
- data/lib/mencoro/api/invitations_api.rb +1 -1
- data/lib/mencoro/api/jobs_api.rb +3 -3
- data/lib/mencoro/api/members_api.rb +95 -1
- data/lib/mencoro/api/organization_operations_api.rb +1 -1
- data/lib/mencoro/api/organizations_api.rb +7 -7
- data/lib/mencoro/api/projects_api.rb +80 -5
- data/lib/mencoro/api/tracked_queries_api.rb +220 -8
- data/lib/mencoro/api_client.rb +2 -2
- data/lib/mencoro/api_error.rb +1 -1
- data/lib/mencoro/api_model_base.rb +1 -1
- data/lib/mencoro/configuration.rb +1 -1
- data/lib/mencoro/models/accepted_job_resource.rb +1 -1
- data/lib/mencoro/models/ai_response_report_resource.rb +1 -1
- data/lib/mencoro/models/ai_response_resource.rb +1 -1
- data/lib/mencoro/models/apply_clustering_job_outcome.rb +1 -1
- data/lib/mencoro/models/apply_clustering_job_outcome_clusters_inner.rb +1 -1
- data/lib/mencoro/models/apply_clustering_job_outcome_failed_inner.rb +1 -1
- data/lib/mencoro/models/apply_clustering_job_outcome_skipped_clusters_inner.rb +1 -1
- data/lib/mencoro/models/apply_clustering_job_outcome_successful_inner.rb +1 -1
- data/lib/mencoro/models/async_job_resource.rb +17 -7
- data/lib/mencoro/models/async_job_resource_error.rb +217 -0
- data/lib/mencoro/models/batch_change_tracked_query_check_frequency_request_data.rb +1 -1
- data/lib/mencoro/models/batch_change_tracked_query_passes_request_data.rb +1 -1
- data/lib/mencoro/models/batch_create_query_clusters_outcome.rb +1 -1
- data/lib/mencoro/models/batch_create_query_clusters_outcome_failed_inner.rb +1 -1
- data/lib/mencoro/models/batch_create_query_clusters_outcome_successful_inner.rb +1 -1
- data/lib/mencoro/models/batch_create_query_clusters_request_data.rb +1 -1
- data/lib/mencoro/models/batch_create_tracked_queries_request_data.rb +1 -1
- data/lib/mencoro/models/batch_create_tracked_queries_result_resource.rb +1 -1
- data/lib/mencoro/models/batch_create_tracked_queries_result_resource_failed_inner.rb +1 -1
- data/lib/mencoro/models/batch_create_tracked_queries_result_resource_successful_inner.rb +1 -1
- data/lib/mencoro/models/batch_force_check_tracked_queries200_response.rb +1 -1
- data/lib/mencoro/models/batch_force_check_tracked_queries200_response_failed_inner.rb +1 -1
- data/lib/mencoro/models/batch_pause_tracked_queries200_response.rb +1 -1
- data/lib/mencoro/models/batch_pause_tracked_queries200_response_failed_inner.rb +1 -1
- data/lib/mencoro/models/batch_pause_tracked_queries200_response_successful_inner.rb +1 -1
- data/lib/mencoro/models/batch_resume_tracked_queries200_response.rb +1 -1
- data/lib/mencoro/models/batch_targets_request_data.rb +1 -1
- data/lib/mencoro/models/batch_write_outcome.rb +1 -1
- data/lib/mencoro/models/batch_write_outcome_failed_inner.rb +1 -1
- data/lib/mencoro/models/brand_profile_resource.rb +1 -1
- data/lib/mencoro/models/bulk_add_clusters_to_tracked_queries200_response.rb +1 -1
- data/lib/mencoro/models/bulk_add_clusters_to_tracked_queries_request.rb +1 -1
- data/lib/mencoro/models/bulk_remove_clusters_from_tracked_queries200_response.rb +1 -1
- data/lib/mencoro/models/bulk_remove_clusters_from_tracked_queries_request.rb +1 -1
- data/lib/mencoro/models/change_member_role_request.rb +1 -1
- data/lib/mencoro/models/change_tracked_query_check_frequency_request_data.rb +1 -1
- data/lib/mencoro/models/change_tracked_query_passes_request_data.rb +1 -1
- data/lib/mencoro/models/citation_resource.rb +1 -1
- data/lib/mencoro/models/cited_source_row.rb +298 -0
- data/lib/mencoro/models/cited_sources_response.rb +192 -0
- data/lib/mencoro/models/cluster_breakdown_row.rb +580 -0
- data/lib/mencoro/models/cluster_membership_request_data.rb +1 -1
- data/lib/mencoro/models/competitor_co_occurrence_response.rb +166 -0
- data/lib/mencoro/models/competitor_co_occurrence_row.rb +318 -0
- data/lib/mencoro/models/competitor_resource.rb +1 -1
- data/lib/mencoro/models/competitor_share_of_voice.rb +174 -0
- data/lib/mencoro/models/create_competitor_request.rb +1 -1
- data/lib/mencoro/models/create_invitation200_response.rb +1 -1
- data/lib/mencoro/models/create_invitation201_response.rb +60 -2
- data/lib/mencoro/models/create_invitation_request.rb +15 -5
- data/lib/mencoro/models/create_invitation_request_project_access.rb +201 -0
- data/lib/mencoro/models/create_organization201_response.rb +1 -1
- data/lib/mencoro/models/create_organization_request.rb +1 -1
- data/lib/mencoro/models/create_project_request.rb +1 -1
- data/lib/mencoro/models/create_project_request_competitors_inner.rb +1 -1
- data/lib/mencoro/models/create_query_cluster409_response.rb +1 -1
- data/lib/mencoro/models/create_query_cluster_request.rb +1 -1
- data/lib/mencoro/models/delete_query_cluster200_response.rb +1 -1
- data/lib/mencoro/models/entitlements_resource.rb +1 -1
- data/lib/mencoro/models/get_available_filters200_response.rb +1 -1
- data/lib/mencoro/models/get_available_filters200_response_clusters_inner.rb +1 -1
- data/lib/mencoro/models/get_me_stats200_response.rb +1 -1
- data/lib/mencoro/models/get_me_stats200_response_organizations.rb +1 -1
- data/lib/mencoro/models/get_me_stats200_response_projects.rb +2 -2
- data/lib/mencoro/models/get_membership_stats200_response.rb +1 -1
- data/lib/mencoro/models/get_mention_samples400_response.rb +1 -1
- data/lib/mencoro/models/get_mention_samples400_response_details_value_inner.rb +1 -1
- data/lib/mencoro/models/get_metric_glossary200_response.rb +1 -1
- data/lib/mencoro/models/get_metric_glossary200_response_metrics_inner.rb +1 -1
- data/lib/mencoro/models/get_organization_overview200_response.rb +1 -1
- data/lib/mencoro/models/get_organization_overview200_response_aggregate.rb +2 -2
- data/lib/mencoro/models/get_organization_overview200_response_projects_inner.rb +34 -3
- data/lib/mencoro/models/get_organization_stats200_response.rb +1 -1
- data/lib/mencoro/models/get_organization_stats200_response_invitations.rb +4 -7
- data/lib/mencoro/models/get_organization_stats200_response_members.rb +4 -7
- data/lib/mencoro/models/get_organization_stats200_response_projects.rb +2 -2
- data/lib/mencoro/models/get_share_of_voice_formula200_response.rb +1 -1
- data/lib/mencoro/models/get_tracking_coverage200_response.rb +1 -1
- data/lib/mencoro/models/get_tracking_coverage200_response_sample_inner.rb +1 -1
- data/lib/mencoro/models/invitation_resource.rb +64 -6
- data/lib/mencoro/models/keyword_listing_resource.rb +40 -14
- data/lib/mencoro/models/keyword_listing_resource_carried_positions.rb +187 -0
- data/lib/mencoro/models/keyword_listing_resource_carried_positions_serp.rb +192 -0
- data/lib/mencoro/models/keyword_listing_resource_mention_type_counts.rb +1 -1
- data/lib/mencoro/models/list_ai_responses200_response.rb +1 -1
- data/lib/mencoro/models/list_competitors200_response.rb +1 -1
- data/lib/mencoro/models/list_invitations200_response.rb +1 -1
- data/lib/mencoro/models/list_keyword_listings200_response.rb +1 -1
- data/lib/mencoro/models/list_members200_response.rb +1 -1
- data/lib/mencoro/models/list_organizations200_response.rb +1 -1
- data/lib/mencoro/models/list_projects200_response.rb +2 -2
- data/lib/mencoro/models/list_query_clusters200_response.rb +1 -1
- data/lib/mencoro/models/list_search_snapshots200_response.rb +1 -1
- data/lib/mencoro/models/list_shopping_snapshots200_response.rb +1 -1
- data/lib/mencoro/models/me_resource.rb +1 -1
- data/lib/mencoro/models/member_resource.rb +63 -5
- data/lib/mencoro/models/mention_match_resource.rb +432 -0
- data/lib/mencoro/models/mention_sample_response.rb +450 -0
- data/lib/mencoro/models/mention_type_counts.rb +268 -0
- data/lib/mencoro/models/operation_effect.rb +1 -1
- data/lib/mencoro/models/organization_resource.rb +1 -1
- data/lib/mencoro/models/per_competitor_sentiment.rb +304 -0
- data/lib/mencoro/models/per_engine_sentiment.rb +278 -0
- data/lib/mencoro/models/per_entity_metrics.rb +218 -0
- data/lib/mencoro/models/position_distribution_bucket.rb +190 -0
- data/lib/mencoro/models/preview_organization_operation200_response.rb +1 -1
- data/lib/mencoro/models/preview_organization_operation200_response_organization.rb +1 -1
- data/lib/mencoro/models/preview_organization_operation_request.rb +3 -3
- data/lib/mencoro/models/project_detail_resource.rb +1 -1
- data/lib/mencoro/models/project_detail_resource_competitors_inner.rb +1 -1
- data/lib/mencoro/models/project_mention_mix_response.rb +222 -0
- data/lib/mencoro/models/project_mention_samples_response.rb +192 -0
- data/lib/mencoro/models/project_rank_tracking_cluster_breakdown.rb +176 -0
- data/lib/mencoro/models/project_rank_tracking_stats.rb +718 -0
- data/lib/mencoro/models/project_rank_tracking_time_series.rb +176 -0
- data/lib/mencoro/models/project_resource.rb +1 -1
- data/lib/mencoro/models/project_sentiment_breakdown.rb +194 -0
- data/lib/mencoro/models/projected_monthly_checks_resource.rb +3 -3
- data/lib/mencoro/models/query_cluster_resource.rb +1 -1
- data/lib/mencoro/models/report_ai_response_request.rb +1 -1
- data/lib/mencoro/models/search_result_resource.rb +1 -1
- data/lib/mencoro/models/search_snapshot_resource.rb +1 -1
- data/lib/mencoro/models/search_tracked_queries200_response.rb +1 -1
- data/lib/mencoro/models/search_tracked_query_mention_matches200_response.rb +158 -0
- data/lib/mencoro/models/search_tracked_query_serp_matches200_response.rb +158 -0
- data/lib/mencoro/models/serp_match_resource.rb +314 -0
- data/lib/mencoro/models/set_member_project_access_request.rb +200 -0
- data/lib/mencoro/models/shopping_offer_resource.rb +1 -1
- data/lib/mencoro/models/shopping_snapshot_resource.rb +1 -1
- data/lib/mencoro/models/start_brand_discovery_job_request.rb +1 -1
- data/lib/mencoro/models/start_brand_name_suggestion_job_request.rb +1 -1
- data/lib/mencoro/models/start_clustering_job_request_data.rb +1 -1
- data/lib/mencoro/models/start_keyword_discovery_job_request.rb +1 -1
- data/lib/mencoro/models/start_prompt_discovery_job_request.rb +1 -1
- data/lib/mencoro/models/submitted_checks_resource.rb +1 -1
- data/lib/mencoro/models/subscription_resource.rb +3 -3
- data/lib/mencoro/models/time_series_point.rb +218 -0
- data/lib/mencoro/models/tracked_query_count_resource.rb +3 -3
- data/lib/mencoro/models/tracked_query_detail_resource.rb +3 -3
- data/lib/mencoro/models/tracked_query_mover_row.rb +492 -0
- data/lib/mencoro/models/tracked_query_movers_response.rb +202 -0
- data/lib/mencoro/models/tracked_query_rank_tracking_time_series.rb +176 -0
- data/lib/mencoro/models/tracked_query_resource.rb +3 -3
- data/lib/mencoro/models/tracked_query_usage_resource.rb +2 -2
- data/lib/mencoro/models/update_organization_request.rb +1 -1
- data/lib/mencoro/models/update_project_brand_profile_request.rb +1 -1
- data/lib/mencoro/models/update_project_request.rb +1 -1
- data/lib/mencoro/version.rb +2 -2
- data/lib/mencoro.rb +32 -1
- data/mencoro.gemspec +2 -2
- data/spec/models/async_job_resource_error_spec.rb +46 -0
- data/spec/models/cited_source_row_spec.rb +78 -0
- data/spec/models/cited_sources_response_spec.rb +42 -0
- data/spec/models/cluster_breakdown_row_spec.rb +228 -0
- data/spec/models/competitor_co_occurrence_response_spec.rb +36 -0
- data/spec/models/competitor_co_occurrence_row_spec.rb +90 -0
- data/spec/models/competitor_share_of_voice_spec.rb +42 -0
- data/spec/models/create_invitation_request_project_access_spec.rb +46 -0
- data/spec/models/keyword_listing_resource_carried_positions_serp_spec.rb +42 -0
- data/spec/models/keyword_listing_resource_carried_positions_spec.rb +54 -0
- data/spec/models/mention_match_resource_spec.rb +114 -0
- data/spec/models/mention_sample_response_spec.rb +114 -0
- data/spec/models/mention_type_counts_spec.rb +60 -0
- data/spec/models/per_competitor_sentiment_spec.rb +72 -0
- data/spec/models/per_engine_sentiment_spec.rb +66 -0
- data/spec/models/per_entity_metrics_spec.rb +78 -0
- data/spec/models/position_distribution_bucket_spec.rb +42 -0
- data/spec/models/project_mention_mix_response_spec.rb +48 -0
- data/spec/models/project_mention_samples_response_spec.rb +42 -0
- data/spec/models/project_rank_tracking_cluster_breakdown_spec.rb +42 -0
- data/spec/models/project_rank_tracking_stats_spec.rb +270 -0
- data/spec/models/project_rank_tracking_time_series_spec.rb +42 -0
- data/spec/models/project_sentiment_breakdown_spec.rb +42 -0
- data/spec/models/search_tracked_query_mention_matches200_response_spec.rb +42 -0
- data/spec/models/search_tracked_query_serp_matches200_response_spec.rb +42 -0
- data/spec/models/serp_match_resource_spec.rb +72 -0
- data/spec/models/set_member_project_access_request_spec.rb +46 -0
- data/spec/models/time_series_point_spec.rb +48 -0
- data/spec/models/tracked_query_mover_row_spec.rb +156 -0
- data/spec/models/tracked_query_movers_response_spec.rb +48 -0
- data/spec/models/tracked_query_rank_tracking_time_series_spec.rb +42 -0
- data/spec/spec_helper.rb +1 -1
- metadata +235 -108
data/docs/MembersApi.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.mencoro.com*
|
|
|
8
8
|
| [**get_member**](MembersApi.md#get_member) | **GET** /api/v1/organizations/{organizationId}/members/{memberId} | Get one organization membership |
|
|
9
9
|
| [**list_members**](MembersApi.md#list_members) | **GET** /api/v1/organizations/{organizationId}/members | List an organization's members |
|
|
10
10
|
| [**reactivate_member**](MembersApi.md#reactivate_member) | **POST** /api/v1/organizations/{organizationId}/members/{memberId}/reactivate | Reactivate a suspended member |
|
|
11
|
+
| [**set_member_project_access**](MembersApi.md#set_member_project_access) | **PUT** /api/v1/organizations/{organizationId}/members/{memberId}/project-access | Set which projects a member reaches |
|
|
11
12
|
| [**suspend_member**](MembersApi.md#suspend_member) | **POST** /api/v1/organizations/{organizationId}/members/{memberId}/suspend | Suspend a member |
|
|
12
13
|
|
|
13
14
|
|
|
@@ -315,6 +316,83 @@ end
|
|
|
315
316
|
- **Accept**: application/json
|
|
316
317
|
|
|
317
318
|
|
|
319
|
+
## set_member_project_access
|
|
320
|
+
|
|
321
|
+
> <MemberResource> set_member_project_access(organization_id, member_id, x_mencoro_confirmation, idempotency_key, set_member_project_access_request)
|
|
322
|
+
|
|
323
|
+
Set which projects a member reaches
|
|
324
|
+
|
|
325
|
+
Minimum role: owner. A member reaches every project of the organization (`all`) or only the listed projects (`selected`); a project outside a selection answers as if it did not exist. The change applies from the member's next request, including through any API key or MCP connection they own. An owner always reaches every project and cannot be limited. Setting the access a member already has changes nothing. Preview it first: the confirmation is bound to the member's access at preview time, so another change in between invalidates it.
|
|
326
|
+
|
|
327
|
+
### Examples
|
|
328
|
+
|
|
329
|
+
```ruby
|
|
330
|
+
require 'time'
|
|
331
|
+
require 'mencoro'
|
|
332
|
+
# setup authorization
|
|
333
|
+
Mencoro.configure do |config|
|
|
334
|
+
# Configure Bearer authorization: ApiKey
|
|
335
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
336
|
+
end
|
|
337
|
+
|
|
338
|
+
api_instance = Mencoro::MembersApi.new
|
|
339
|
+
organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
340
|
+
member_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
341
|
+
x_mencoro_confirmation = 'x_mencoro_confirmation_example' # String |
|
|
342
|
+
idempotency_key = 'idempotency_key_example' # String |
|
|
343
|
+
set_member_project_access_request = Mencoro::SetMemberProjectAccessRequest.new({mode: 'all'}) # SetMemberProjectAccessRequest |
|
|
344
|
+
|
|
345
|
+
begin
|
|
346
|
+
# Set which projects a member reaches
|
|
347
|
+
result = api_instance.set_member_project_access(organization_id, member_id, x_mencoro_confirmation, idempotency_key, set_member_project_access_request)
|
|
348
|
+
p result
|
|
349
|
+
rescue Mencoro::ApiError => e
|
|
350
|
+
puts "Error when calling MembersApi->set_member_project_access: #{e}"
|
|
351
|
+
end
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
#### Using the set_member_project_access_with_http_info variant
|
|
355
|
+
|
|
356
|
+
This returns an Array which contains the response data, status code and headers.
|
|
357
|
+
|
|
358
|
+
> <Array(<MemberResource>, Integer, Hash)> set_member_project_access_with_http_info(organization_id, member_id, x_mencoro_confirmation, idempotency_key, set_member_project_access_request)
|
|
359
|
+
|
|
360
|
+
```ruby
|
|
361
|
+
begin
|
|
362
|
+
# Set which projects a member reaches
|
|
363
|
+
data, status_code, headers = api_instance.set_member_project_access_with_http_info(organization_id, member_id, x_mencoro_confirmation, idempotency_key, set_member_project_access_request)
|
|
364
|
+
p status_code # => 2xx
|
|
365
|
+
p headers # => { ... }
|
|
366
|
+
p data # => <MemberResource>
|
|
367
|
+
rescue Mencoro::ApiError => e
|
|
368
|
+
puts "Error when calling MembersApi->set_member_project_access_with_http_info: #{e}"
|
|
369
|
+
end
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Parameters
|
|
373
|
+
|
|
374
|
+
| Name | Type | Description | Notes |
|
|
375
|
+
| ---- | ---- | ----------- | ----- |
|
|
376
|
+
| **organization_id** | **String** | | |
|
|
377
|
+
| **member_id** | **String** | | |
|
|
378
|
+
| **x_mencoro_confirmation** | **String** | | |
|
|
379
|
+
| **idempotency_key** | **String** | | |
|
|
380
|
+
| **set_member_project_access_request** | [**SetMemberProjectAccessRequest**](SetMemberProjectAccessRequest.md) | | |
|
|
381
|
+
|
|
382
|
+
### Return type
|
|
383
|
+
|
|
384
|
+
[**MemberResource**](MemberResource.md)
|
|
385
|
+
|
|
386
|
+
### Authorization
|
|
387
|
+
|
|
388
|
+
[ApiKey](../README.md#ApiKey)
|
|
389
|
+
|
|
390
|
+
### HTTP request headers
|
|
391
|
+
|
|
392
|
+
- **Content-Type**: application/json
|
|
393
|
+
- **Accept**: application/json
|
|
394
|
+
|
|
395
|
+
|
|
318
396
|
## suspend_member
|
|
319
397
|
|
|
320
398
|
> <MemberResource> suspend_member(organization_id, member_id, x_mencoro_confirmation, idempotency_key)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Mencoro::MentionMatchResource
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **tracked_query_id** | **String** | | |
|
|
8
|
+
| **project_id** | **String** | | |
|
|
9
|
+
| **engine** | **String** | | |
|
|
10
|
+
| **ai_response_id** | **String** | | |
|
|
11
|
+
| **competitor_id** | **String** | | [optional] |
|
|
12
|
+
| **mention_position** | **Integer** | | |
|
|
13
|
+
| **sentiment** | **String** | | |
|
|
14
|
+
| **mention_type** | **String** | | |
|
|
15
|
+
| **mention_type_condition** | **String** | | [optional] |
|
|
16
|
+
| **response_context** | **String** | | |
|
|
17
|
+
| **detected_at** | **Time** | | |
|
|
18
|
+
| **mention_relation** | **String** | | [optional] |
|
|
19
|
+
| **brand_name** | **String** | | [optional] |
|
|
20
|
+
| **brand_name_as_mentioned** | **String** | | [optional] |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'mencoro'
|
|
26
|
+
|
|
27
|
+
instance = Mencoro::MentionMatchResource.new(
|
|
28
|
+
tracked_query_id: null,
|
|
29
|
+
project_id: null,
|
|
30
|
+
engine: null,
|
|
31
|
+
ai_response_id: null,
|
|
32
|
+
competitor_id: null,
|
|
33
|
+
mention_position: null,
|
|
34
|
+
sentiment: null,
|
|
35
|
+
mention_type: null,
|
|
36
|
+
mention_type_condition: null,
|
|
37
|
+
response_context: null,
|
|
38
|
+
detected_at: null,
|
|
39
|
+
mention_relation: null,
|
|
40
|
+
brand_name: null,
|
|
41
|
+
brand_name_as_mentioned: null
|
|
42
|
+
)
|
|
43
|
+
```
|
|
44
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Mencoro::MentionSampleResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **tracked_query_id** | **String** | | |
|
|
9
|
+
| **ai_response_id** | **String** | | |
|
|
10
|
+
| **engine** | **String** | | |
|
|
11
|
+
| **competitor_id** | **String** | | [optional] |
|
|
12
|
+
| **sentiment** | **String** | | |
|
|
13
|
+
| **mention_type** | **String** | | |
|
|
14
|
+
| **mention_position** | **Integer** | | |
|
|
15
|
+
| **text** | **String** | | |
|
|
16
|
+
| **detected_at** | **String** | | |
|
|
17
|
+
| **query_text** | **String** | | |
|
|
18
|
+
| **country** | **String** | | [optional] |
|
|
19
|
+
| **mention_relation** | **String** | Published because `competitorId` alone cannot answer the question. Own-brand AND untracked-competitor mentions both carry a null competitor id - the confusion migration Version20260608130000 was written to end - so a reader that treats a null competitor id as \"us\" silently counts a rival as the brand. | [optional] |
|
|
20
|
+
| **brand_name** | **String** | | [optional] |
|
|
21
|
+
| **citations** | [**Array<CitationResource>**](CitationResource.md) | | [optional] |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'mencoro'
|
|
27
|
+
|
|
28
|
+
instance = Mencoro::MentionSampleResponse.new(
|
|
29
|
+
id: null,
|
|
30
|
+
tracked_query_id: null,
|
|
31
|
+
ai_response_id: null,
|
|
32
|
+
engine: null,
|
|
33
|
+
competitor_id: null,
|
|
34
|
+
sentiment: null,
|
|
35
|
+
mention_type: null,
|
|
36
|
+
mention_position: null,
|
|
37
|
+
text: null,
|
|
38
|
+
detected_at: null,
|
|
39
|
+
query_text: null,
|
|
40
|
+
country: null,
|
|
41
|
+
mention_relation: null,
|
|
42
|
+
brand_name: null,
|
|
43
|
+
citations: null
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Mencoro::MentionTypeCounts
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **recommendation** | **Integer** | | |
|
|
8
|
+
| **comparison** | **Integer** | | |
|
|
9
|
+
| **listing** | **Integer** | | |
|
|
10
|
+
| **example** | **Integer** | | |
|
|
11
|
+
| **reference** | **Integer** | | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'mencoro'
|
|
17
|
+
|
|
18
|
+
instance = Mencoro::MentionTypeCounts.new(
|
|
19
|
+
recommendation: null,
|
|
20
|
+
comparison: null,
|
|
21
|
+
listing: null,
|
|
22
|
+
example: null,
|
|
23
|
+
reference: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/OrganizationsApi.md
CHANGED
|
@@ -96,7 +96,7 @@ end
|
|
|
96
96
|
|
|
97
97
|
Count the tracked queries an organization has configured
|
|
98
98
|
|
|
99
|
-
Minimum role: viewer. How many tracked queries the organization has configured, counted live in PostgreSQL — the write model — over EVERY project it owns, archived projects included, and over every tracked query in them, active and paused alike. It is deliberately a DIFFERENT number from `aggregate.totalTrackedQueries` in getOrganizationOverview: that one sums a per-project copy held in the Elasticsearch read model and covers ACTIVE projects only, so it excludes archived projects and can lag behind a change that already shows here. Expect the two to disagree and do not treat either as wrong. This figure does reconcile exactly with countTrackedQueries, which counts one project through the same counter in the same store: sum its unfiltered `count` over every project, archived included, and you get this number. For the ACTIVE subset and what it will consume, call getOrganizationProjectedMonthlyChecks, which ranges over the same projects. Do NOT derive the paused count by subtracting one from the other: this number is read live from Postgres while that one is served from a cache invalidated by background subscribers, so the two can disagree while that invalidation catches up and the difference is then a count of nothing. For how many projects this ranges over, read `projects.total` and `projects.active` from getOrganizationStats. The value is never null: 0 means none are configured. This operation takes no query parameters — the population is fixed, and a parameter it cannot honour is rejected with 400 rather than silently ignored.
|
|
99
|
+
Minimum role: viewer. For a member restricted to selected projects, every figure covers those projects only. How many tracked queries the organization has configured, counted live in PostgreSQL — the write model — over EVERY project it owns, archived projects included, and over every tracked query in them, active and paused alike. It is deliberately a DIFFERENT number from `aggregate.totalTrackedQueries` in getOrganizationOverview: that one sums a per-project copy held in the Elasticsearch read model and covers ACTIVE projects only, so it excludes archived projects and can lag behind a change that already shows here. Expect the two to disagree and do not treat either as wrong. This figure does reconcile exactly with countTrackedQueries, which counts one project through the same counter in the same store: sum its unfiltered `count` over every project, archived included, and you get this number. For the ACTIVE subset and what it will consume, call getOrganizationProjectedMonthlyChecks, which ranges over the same projects. Do NOT derive the paused count by subtracting one from the other: this number is read live from Postgres while that one is served from a cache invalidated by background subscribers, so the two can disagree while that invalidation catches up and the difference is then a count of nothing. For how many projects this ranges over, read `projects.total` and `projects.active` from getOrganizationStats. The value is never null: 0 means none are configured. This operation takes no query parameters — the population is fixed, and a parameter it cannot honour is rejected with 400 rather than silently ignored.
|
|
100
100
|
|
|
101
101
|
### Examples
|
|
102
102
|
|
|
@@ -445,7 +445,7 @@ end
|
|
|
445
445
|
|
|
446
446
|
Project a month of check consumption from the current tracking configuration
|
|
447
447
|
|
|
448
|
-
Minimum role: viewer. What the organization's current configuration would consume in a month, in
|
|
448
|
+
Minimum role: viewer. For a member restricted to selected projects, every figure covers those projects only. What the organization's current configuration would consume in a month, in checks — the same unit `checkBudget` and `checksAvailable` are counted in by the entitlements operation — so the two are directly comparable when sizing a plan. The arithmetic is published so it can be reproduced rather than trusted: for each ACTIVE tracked query, runs per month (daily 30, weekly 4, monthly 1) multiplied by its nPasses and engine weight, summed. Claude uses five checks per pass; every other engine uses one. A weekly query runs 4 times per month, not 4.345: a month is modelled as 30 days and 4 weeks, a planning convention rather than a calendar. Take `checkFrequency`, `nPasses` and `engine` from the tracked-query listing and the arithmetic will match — though the two sides are read from different places and settle at different times: this figure is computed in the Postgres write model and served from a cache that background subscribers invalidate, while that listing reads an Elasticsearch projection. Immediately after a write the two can disagree; neither is wrong, they are catching up. PAUSED queries are excluded from both figures; archived PROJECTS are not — archiving a project does not pause its tracked queries, so they still count here, exactly as they do in countOrganizationTrackedQueries. `activeTrackedQueryCount` describes the same population as that count, minus the paused queries — but do not compute the difference to learn how many are paused: THIS OPERATION IS CACHED and that one is read live, so the two can disagree while the cache is invalidated in the background. This is a projection of the configuration, not a forecast of what will actually be spent: it does not look at the remaining plan budget, does not know which checks will be skipped or retried, and reserves and debits nothing. It is also not the `checkCost` of countTrackedQueries, which prices one round over one project rather than a month over the organization. Both values are never null: 0 means nothing is scheduled. This operation takes no query parameters — the population is fixed, and a parameter it cannot honour is rejected with 400 rather than silently ignored.
|
|
449
449
|
|
|
450
450
|
### Examples
|
|
451
451
|
|
|
@@ -514,7 +514,7 @@ end
|
|
|
514
514
|
|
|
515
515
|
Headline counts for an organization
|
|
516
516
|
|
|
517
|
-
Minimum role: viewer. Active members, projects (total and active) and pending invitations, in one call. Every value is a count
|
|
517
|
+
Minimum role: viewer. Active members, projects (total and active) and pending invitations, in one call. Every value is a count: 0 means the organization really has none of that thing you can access. Only `members.total` and `invitations.pending` can be null, and only for a member restricted to selected projects, who is not shown them. `members.total` counts ACTIVE memberships only, so a suspended member is not included; `projects.total` counts every project you can access, archived ones included, and `projects.active` the non-archived subset. For a member restricted to selected projects, the project figures cover those projects only. This is a current-state snapshot and takes no date window.
|
|
518
518
|
|
|
519
519
|
### Examples
|
|
520
520
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Mencoro::PerCompetitorSentiment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **competitor_id** | **String** | | |
|
|
8
|
+
| **positive** | **Integer** | | |
|
|
9
|
+
| **neutral** | **Integer** | | |
|
|
10
|
+
| **negative** | **Integer** | | |
|
|
11
|
+
| **mention_count** | **Integer** | | |
|
|
12
|
+
| **positivity_index** | **Integer** | | [optional] |
|
|
13
|
+
| **mention_type_counts** | [**MentionTypeCounts**](MentionTypeCounts.md) | | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'mencoro'
|
|
19
|
+
|
|
20
|
+
instance = Mencoro::PerCompetitorSentiment.new(
|
|
21
|
+
competitor_id: null,
|
|
22
|
+
positive: null,
|
|
23
|
+
neutral: null,
|
|
24
|
+
negative: null,
|
|
25
|
+
mention_count: null,
|
|
26
|
+
positivity_index: null,
|
|
27
|
+
mention_type_counts: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Mencoro::PerEngineSentiment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **engine** | **String** | | |
|
|
8
|
+
| **positive** | **Integer** | | |
|
|
9
|
+
| **neutral** | **Integer** | | |
|
|
10
|
+
| **negative** | **Integer** | | |
|
|
11
|
+
| **mention_count** | **Integer** | | |
|
|
12
|
+
| **positivity_index** | **Integer** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'mencoro'
|
|
18
|
+
|
|
19
|
+
instance = Mencoro::PerEngineSentiment.new(
|
|
20
|
+
engine: null,
|
|
21
|
+
positive: null,
|
|
22
|
+
neutral: null,
|
|
23
|
+
negative: null,
|
|
24
|
+
mention_count: null,
|
|
25
|
+
positivity_index: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Mencoro::PerEntityMetrics
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **serp** | **Float** | | [optional] |
|
|
8
|
+
| **shopping** | **Float** | | [optional] |
|
|
9
|
+
| **mention** | **Float** | | [optional] |
|
|
10
|
+
| **link** | **Float** | | [optional] |
|
|
11
|
+
| **positivity** | **Integer** | | [optional] |
|
|
12
|
+
| **share_of_voice** | **Float** | | [optional] |
|
|
13
|
+
| **mention_rate** | **Integer** | | [optional] |
|
|
14
|
+
| **serp_rate** | **Integer** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'mencoro'
|
|
20
|
+
|
|
21
|
+
instance = Mencoro::PerEntityMetrics.new(
|
|
22
|
+
serp: null,
|
|
23
|
+
shopping: null,
|
|
24
|
+
mention: null,
|
|
25
|
+
link: null,
|
|
26
|
+
positivity: null,
|
|
27
|
+
share_of_voice: null,
|
|
28
|
+
mention_rate: null,
|
|
29
|
+
serp_rate: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::PositionDistributionBucket
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **bucket** | **String** | | |
|
|
8
|
+
| **count** | **Integer** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::PositionDistributionBucket.new(
|
|
16
|
+
bucket: null,
|
|
17
|
+
count: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Mencoro::ProjectMentionMixResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **by_type** | **Hash<String, Integer>** | | |
|
|
8
|
+
| **by_tone** | **Hash<String, Integer>** | | |
|
|
9
|
+
| **by_qualifier** | **Hash<String, Integer>** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'mencoro'
|
|
15
|
+
|
|
16
|
+
instance = Mencoro::ProjectMentionMixResponse.new(
|
|
17
|
+
by_type: null,
|
|
18
|
+
by_tone: null,
|
|
19
|
+
by_qualifier: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::ProjectMentionSamplesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **samples** | [**Array<MentionSampleResponse>**](MentionSampleResponse.md) | | |
|
|
8
|
+
| **total** | **Integer** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::ProjectMentionSamplesResponse.new(
|
|
16
|
+
samples: null,
|
|
17
|
+
total: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::ProjectRankTrackingClusterBreakdown
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **rows** | [**Array<ClusterBreakdownRow>**](ClusterBreakdownRow.md) | | |
|
|
8
|
+
| **data_dirty_since** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::ProjectRankTrackingClusterBreakdown.new(
|
|
16
|
+
rows: null,
|
|
17
|
+
data_dirty_since: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Mencoro::ProjectRankTrackingStats
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **avg_serp_position** | **Float** | | [optional] |
|
|
8
|
+
| **trend_serp** | **Float** | | [optional] |
|
|
9
|
+
| **avg_shopping_position** | **Float** | | [optional] |
|
|
10
|
+
| **trend_shopping** | **Float** | | [optional] |
|
|
11
|
+
| **avg_mention_position** | **Float** | | [optional] |
|
|
12
|
+
| **trend_mention** | **Float** | | [optional] |
|
|
13
|
+
| **avg_link_position** | **Float** | | [optional] |
|
|
14
|
+
| **trend_link** | **Float** | | [optional] |
|
|
15
|
+
| **mention_position_stability** | **Float** | | [optional] |
|
|
16
|
+
| **trend_stability** | **Float** | | [optional] |
|
|
17
|
+
| **serp_position_stability** | **Float** | | [optional] |
|
|
18
|
+
| **trend_serp_stability** | **Float** | | [optional] |
|
|
19
|
+
| **shopping_position_stability** | **Float** | | [optional] |
|
|
20
|
+
| **trend_shopping_stability** | **Float** | | [optional] |
|
|
21
|
+
| **positivity_index** | **Integer** | | [optional] |
|
|
22
|
+
| **trend_positivity** | **Integer** | | [optional] |
|
|
23
|
+
| **mention_rate** | **Integer** | | [optional] |
|
|
24
|
+
| **trend_mention_rate** | **Integer** | | [optional] |
|
|
25
|
+
| **serp_rate** | **Integer** | | [optional] |
|
|
26
|
+
| **trend_serp_rate** | **Integer** | | [optional] |
|
|
27
|
+
| **shopping_rate** | **Integer** | | [optional] |
|
|
28
|
+
| **trend_shopping_rate** | **Integer** | | [optional] |
|
|
29
|
+
| **share_of_voice** | **Float** | | [optional] |
|
|
30
|
+
| **trend_share_of_voice** | **Float** | | [optional] |
|
|
31
|
+
| **sentiment_positive** | **Integer** | | |
|
|
32
|
+
| **sentiment_neutral** | **Integer** | | |
|
|
33
|
+
| **sentiment_negative** | **Integer** | | |
|
|
34
|
+
| **mention_count** | **Integer** | | |
|
|
35
|
+
| **ai_tracked_query_count** | **Integer** | | |
|
|
36
|
+
| **ai_queries_with_mention** | **Integer** | | |
|
|
37
|
+
| **serp_tracked_query_count** | **Integer** | | |
|
|
38
|
+
| **serp_queries_with_result** | **Integer** | | |
|
|
39
|
+
| **shopping_tracked_query_count** | **Integer** | | |
|
|
40
|
+
| **shopping_queries_with_result** | **Integer** | | |
|
|
41
|
+
| **mention_type_counts** | [**MentionTypeCounts**](MentionTypeCounts.md) | | |
|
|
42
|
+
| **data_dirty_since** | **String** | | [optional] |
|
|
43
|
+
| **mention_position_distribution** | [**Array<PositionDistributionBucket>**](PositionDistributionBucket.md) | | [optional] |
|
|
44
|
+
| **serp_position_distribution** | [**Array<PositionDistributionBucket>**](PositionDistributionBucket.md) | | [optional] |
|
|
45
|
+
| **shopping_position_distribution** | [**Array<PositionDistributionBucket>**](PositionDistributionBucket.md) | | [optional] |
|
|
46
|
+
| **competitor_share_of_voice** | [**Array<CompetitorShareOfVoice>**](CompetitorShareOfVoice.md) | | [optional] |
|
|
47
|
+
|
|
48
|
+
## Example
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
require 'mencoro'
|
|
52
|
+
|
|
53
|
+
instance = Mencoro::ProjectRankTrackingStats.new(
|
|
54
|
+
avg_serp_position: null,
|
|
55
|
+
trend_serp: null,
|
|
56
|
+
avg_shopping_position: null,
|
|
57
|
+
trend_shopping: null,
|
|
58
|
+
avg_mention_position: null,
|
|
59
|
+
trend_mention: null,
|
|
60
|
+
avg_link_position: null,
|
|
61
|
+
trend_link: null,
|
|
62
|
+
mention_position_stability: null,
|
|
63
|
+
trend_stability: null,
|
|
64
|
+
serp_position_stability: null,
|
|
65
|
+
trend_serp_stability: null,
|
|
66
|
+
shopping_position_stability: null,
|
|
67
|
+
trend_shopping_stability: null,
|
|
68
|
+
positivity_index: null,
|
|
69
|
+
trend_positivity: null,
|
|
70
|
+
mention_rate: null,
|
|
71
|
+
trend_mention_rate: null,
|
|
72
|
+
serp_rate: null,
|
|
73
|
+
trend_serp_rate: null,
|
|
74
|
+
shopping_rate: null,
|
|
75
|
+
trend_shopping_rate: null,
|
|
76
|
+
share_of_voice: null,
|
|
77
|
+
trend_share_of_voice: null,
|
|
78
|
+
sentiment_positive: null,
|
|
79
|
+
sentiment_neutral: null,
|
|
80
|
+
sentiment_negative: null,
|
|
81
|
+
mention_count: null,
|
|
82
|
+
ai_tracked_query_count: null,
|
|
83
|
+
ai_queries_with_mention: null,
|
|
84
|
+
serp_tracked_query_count: null,
|
|
85
|
+
serp_queries_with_result: null,
|
|
86
|
+
shopping_tracked_query_count: null,
|
|
87
|
+
shopping_queries_with_result: null,
|
|
88
|
+
mention_type_counts: null,
|
|
89
|
+
data_dirty_since: null,
|
|
90
|
+
mention_position_distribution: null,
|
|
91
|
+
serp_position_distribution: null,
|
|
92
|
+
shopping_position_distribution: null,
|
|
93
|
+
competitor_share_of_voice: null
|
|
94
|
+
)
|
|
95
|
+
```
|
|
96
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::ProjectRankTrackingTimeSeries
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **points** | [**Array<TimeSeriesPoint>**](TimeSeriesPoint.md) | | |
|
|
8
|
+
| **data_dirty_since** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::ProjectRankTrackingTimeSeries.new(
|
|
16
|
+
points: null,
|
|
17
|
+
data_dirty_since: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::ProjectSentimentBreakdown
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **per_engine** | [**Array<PerEngineSentiment>**](PerEngineSentiment.md) | | |
|
|
8
|
+
| **per_competitor** | [**Array<PerCompetitorSentiment>**](PerCompetitorSentiment.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::ProjectSentimentBreakdown.new(
|
|
16
|
+
per_engine: null,
|
|
17
|
+
per_competitor: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **projected_monthly_checks** | **Integer** | Checks a month of the current configuration would consume: for each ACTIVE tracked query, its runs per month (daily 30, weekly 4, monthly 1) multiplied by its nPasses, summed. Never null. | |
|
|
8
|
-
| **active_tracked_query_count** | **Integer** | Active tracked queries the projection was summed over, across every project of the organization, archived projects included. Paused queries are excluded from both figures. Never null. | |
|
|
7
|
+
| **projected_monthly_checks** | **Integer** | Checks a month of the current configuration would consume: for each ACTIVE tracked query, its runs per month (daily 30, weekly 4, monthly 1) multiplied by its nPasses and engine weight, summed. Claude uses five checks per pass; every other engine uses one. Never null. | |
|
|
8
|
+
| **active_tracked_query_count** | **Integer** | Active tracked queries the projection was summed over, across every project of the organization the caller can access, archived projects included. Paused queries are excluded from both figures. Never null. | |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|