mencoro 1.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.
Files changed (401) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +304 -0
  4. data/Rakefile +10 -0
  5. data/docs/AcceptedJobResource.md +22 -0
  6. data/docs/AccountApi.md +141 -0
  7. data/docs/AiResponseReportResource.md +28 -0
  8. data/docs/AiResponseResource.md +36 -0
  9. data/docs/AnalyticsApi.md +1320 -0
  10. data/docs/ApplyClusteringJobOutcome.md +26 -0
  11. data/docs/ApplyClusteringJobOutcomeClustersInner.md +22 -0
  12. data/docs/ApplyClusteringJobOutcomeFailedInner.md +22 -0
  13. data/docs/ApplyClusteringJobOutcomeSkippedClustersInner.md +20 -0
  14. data/docs/ApplyClusteringJobOutcomeSuccessfulInner.md +20 -0
  15. data/docs/AsyncJobResource.md +24 -0
  16. data/docs/BatchChangeTrackedQueryCheckFrequencyRequestData.md +20 -0
  17. data/docs/BatchChangeTrackedQueryPassesRequestData.md +20 -0
  18. data/docs/BatchCreateQueryClustersOutcome.md +20 -0
  19. data/docs/BatchCreateQueryClustersOutcomeFailedInner.md +22 -0
  20. data/docs/BatchCreateQueryClustersOutcomeSuccessfulInner.md +20 -0
  21. data/docs/BatchCreateQueryClustersRequestData.md +18 -0
  22. data/docs/BatchCreateTrackedQueriesRequestData.md +30 -0
  23. data/docs/BatchCreateTrackedQueriesResultResource.md +20 -0
  24. data/docs/BatchCreateTrackedQueriesResultResourceFailedInner.md +26 -0
  25. data/docs/BatchCreateTrackedQueriesResultResourceSuccessfulInner.md +24 -0
  26. data/docs/BatchForceCheckTrackedQueries200Response.md +20 -0
  27. data/docs/BatchForceCheckTrackedQueries200ResponseFailedInner.md +22 -0
  28. data/docs/BatchPauseTrackedQueries200Response.md +20 -0
  29. data/docs/BatchPauseTrackedQueries200ResponseFailedInner.md +22 -0
  30. data/docs/BatchPauseTrackedQueries200ResponseSuccessfulInner.md +18 -0
  31. data/docs/BatchResumeTrackedQueries200Response.md +20 -0
  32. data/docs/BatchTargetsRequestData.md +18 -0
  33. data/docs/BatchWriteOutcome.md +20 -0
  34. data/docs/BatchWriteOutcomeFailedInner.md +22 -0
  35. data/docs/BillingApi.md +77 -0
  36. data/docs/BrandProfileResource.md +24 -0
  37. data/docs/BulkAddClustersToTrackedQueries200Response.md +20 -0
  38. data/docs/BulkAddClustersToTrackedQueriesRequest.md +20 -0
  39. data/docs/BulkRemoveClustersFromTrackedQueries200Response.md +20 -0
  40. data/docs/BulkRemoveClustersFromTrackedQueriesRequest.md +20 -0
  41. data/docs/CapturesApi.md +267 -0
  42. data/docs/ChangeMemberRoleRequest.md +18 -0
  43. data/docs/ChangeTrackedQueryCheckFrequencyRequestData.md +18 -0
  44. data/docs/ChangeTrackedQueryPassesRequestData.md +18 -0
  45. data/docs/CitationResource.md +36 -0
  46. data/docs/ClusterMembershipRequestData.md +18 -0
  47. data/docs/ClustersApi.md +465 -0
  48. data/docs/CompetitorResource.md +24 -0
  49. data/docs/CreateCompetitorRequest.md +22 -0
  50. data/docs/CreateInvitation200Response.md +22 -0
  51. data/docs/CreateInvitation201Response.md +32 -0
  52. data/docs/CreateInvitationRequest.md +20 -0
  53. data/docs/CreateOrganization201Response.md +22 -0
  54. data/docs/CreateOrganizationRequest.md +18 -0
  55. data/docs/CreateProjectRequest.md +24 -0
  56. data/docs/CreateProjectRequestCompetitorsInner.md +22 -0
  57. data/docs/CreateQueryCluster409Response.md +22 -0
  58. data/docs/CreateQueryClusterRequest.md +18 -0
  59. data/docs/DeleteQueryCluster200Response.md +22 -0
  60. data/docs/DiscoveryApi.md +311 -0
  61. data/docs/EntitlementsResource.md +38 -0
  62. data/docs/GetAvailableFilters200Response.md +22 -0
  63. data/docs/GetAvailableFilters200ResponseClustersInner.md +20 -0
  64. data/docs/GetMeStats200Response.md +20 -0
  65. data/docs/GetMeStats200ResponseOrganizations.md +18 -0
  66. data/docs/GetMeStats200ResponseProjects.md +20 -0
  67. data/docs/GetMembershipStats200Response.md +30 -0
  68. data/docs/GetMentionSamples400Response.md +24 -0
  69. data/docs/GetMentionSamples400ResponseDetailsValueInner.md +22 -0
  70. data/docs/GetMetricGlossary200Response.md +18 -0
  71. data/docs/GetMetricGlossary200ResponseMetricsInner.md +30 -0
  72. data/docs/GetOrganizationOverview200Response.md +20 -0
  73. data/docs/GetOrganizationOverview200ResponseAggregate.md +30 -0
  74. data/docs/GetOrganizationOverview200ResponseProjectsInner.md +32 -0
  75. data/docs/GetOrganizationStats200Response.md +22 -0
  76. data/docs/GetOrganizationStats200ResponseInvitations.md +18 -0
  77. data/docs/GetOrganizationStats200ResponseMembers.md +18 -0
  78. data/docs/GetOrganizationStats200ResponseProjects.md +20 -0
  79. data/docs/GetShareOfVoiceFormula200Response.md +24 -0
  80. data/docs/GetTrackingCoverage200Response.md +30 -0
  81. data/docs/GetTrackingCoverage200ResponseSampleInner.md +28 -0
  82. data/docs/InvitationResource.md +30 -0
  83. data/docs/InvitationsApi.md +243 -0
  84. data/docs/JobsApi.md +79 -0
  85. data/docs/KeywordListingResource.md +88 -0
  86. data/docs/KeywordListingResourceMentionTypeCounts.md +26 -0
  87. data/docs/ListAiResponses200Response.md +20 -0
  88. data/docs/ListCompetitors200Response.md +20 -0
  89. data/docs/ListInvitations200Response.md +20 -0
  90. data/docs/ListKeywordListings200Response.md +24 -0
  91. data/docs/ListMembers200Response.md +20 -0
  92. data/docs/ListOrganizations200Response.md +20 -0
  93. data/docs/ListProjects200Response.md +20 -0
  94. data/docs/ListQueryClusters200Response.md +20 -0
  95. data/docs/ListSearchSnapshots200Response.md +20 -0
  96. data/docs/ListShoppingSnapshots200Response.md +20 -0
  97. data/docs/MeResource.md +34 -0
  98. data/docs/MemberResource.md +28 -0
  99. data/docs/MembersApi.md +391 -0
  100. data/docs/OperationEffect.md +22 -0
  101. data/docs/OrganizationOperationsApi.md +77 -0
  102. data/docs/OrganizationResource.md +32 -0
  103. data/docs/OrganizationsApi.md +807 -0
  104. data/docs/PreviewOrganizationOperation200Response.md +34 -0
  105. data/docs/PreviewOrganizationOperation200ResponseOrganization.md +20 -0
  106. data/docs/PreviewOrganizationOperationRequest.md +24 -0
  107. data/docs/ProjectDetailResource.md +32 -0
  108. data/docs/ProjectDetailResourceCompetitorsInner.md +24 -0
  109. data/docs/ProjectResource.md +50 -0
  110. data/docs/ProjectedMonthlyChecksResource.md +20 -0
  111. data/docs/ProjectsApi.md +999 -0
  112. data/docs/QueryClusterResource.md +22 -0
  113. data/docs/ReportAiResponseRequest.md +22 -0
  114. data/docs/SearchResultResource.md +32 -0
  115. data/docs/SearchSnapshotResource.md +28 -0
  116. data/docs/SearchTrackedQueries200Response.md +20 -0
  117. data/docs/ShoppingOfferResource.md +38 -0
  118. data/docs/ShoppingSnapshotResource.md +28 -0
  119. data/docs/StartBrandDiscoveryJobRequest.md +20 -0
  120. data/docs/StartBrandNameSuggestionJobRequest.md +24 -0
  121. data/docs/StartClusteringJobRequestData.md +22 -0
  122. data/docs/StartKeywordDiscoveryJobRequest.md +24 -0
  123. data/docs/StartPromptDiscoveryJobRequest.md +24 -0
  124. data/docs/SubmittedChecksResource.md +20 -0
  125. data/docs/SubscriptionResource.md +42 -0
  126. data/docs/TrackedQueriesApi.md +1549 -0
  127. data/docs/TrackedQueryCountResource.md +20 -0
  128. data/docs/TrackedQueryDetailResource.md +38 -0
  129. data/docs/TrackedQueryResource.md +52 -0
  130. data/docs/TrackedQueryUsageResource.md +18 -0
  131. data/docs/UpdateOrganizationRequest.md +22 -0
  132. data/docs/UpdateProjectBrandProfileRequest.md +20 -0
  133. data/docs/UpdateProjectRequest.md +18 -0
  134. data/git_push.sh +57 -0
  135. data/lib/mencoro/api/account_api.rb +136 -0
  136. data/lib/mencoro/api/analytics_api.rb +1555 -0
  137. data/lib/mencoro/api/billing_api.rb +85 -0
  138. data/lib/mencoro/api/captures_api.rb +338 -0
  139. data/lib/mencoro/api/clusters_api.rb +548 -0
  140. data/lib/mencoro/api/discovery_api.rb +360 -0
  141. data/lib/mencoro/api/invitations_api.rb +302 -0
  142. data/lib/mencoro/api/jobs_api.rb +91 -0
  143. data/lib/mencoro/api/members_api.rb +453 -0
  144. data/lib/mencoro/api/organization_operations_api.rb +90 -0
  145. data/lib/mencoro/api/organizations_api.rb +835 -0
  146. data/lib/mencoro/api/projects_api.rb +1158 -0
  147. data/lib/mencoro/api/tracked_queries_api.rb +1792 -0
  148. data/lib/mencoro/api_client.rb +441 -0
  149. data/lib/mencoro/api_error.rb +58 -0
  150. data/lib/mencoro/api_model_base.rb +88 -0
  151. data/lib/mencoro/configuration.rb +392 -0
  152. data/lib/mencoro/models/accepted_job_resource.rb +220 -0
  153. data/lib/mencoro/models/ai_response_report_resource.rb +311 -0
  154. data/lib/mencoro/models/ai_response_resource.rb +412 -0
  155. data/lib/mencoro/models/apply_clustering_job_outcome.rb +199 -0
  156. data/lib/mencoro/models/apply_clustering_job_outcome_clusters_inner.rb +165 -0
  157. data/lib/mencoro/models/apply_clustering_job_outcome_failed_inner.rb +165 -0
  158. data/lib/mencoro/models/apply_clustering_job_outcome_skipped_clusters_inner.rb +156 -0
  159. data/lib/mencoro/models/apply_clustering_job_outcome_successful_inner.rb +158 -0
  160. data/lib/mencoro/models/async_job_resource.rb +256 -0
  161. data/lib/mencoro/models/batch_change_tracked_query_check_frequency_request_data.rb +237 -0
  162. data/lib/mencoro/models/batch_change_tracked_query_passes_request_data.rb +231 -0
  163. data/lib/mencoro/models/batch_create_query_clusters_outcome.rb +163 -0
  164. data/lib/mencoro/models/batch_create_query_clusters_outcome_failed_inner.rb +165 -0
  165. data/lib/mencoro/models/batch_create_query_clusters_outcome_successful_inner.rb +156 -0
  166. data/lib/mencoro/models/batch_create_query_clusters_request_data.rb +186 -0
  167. data/lib/mencoro/models/batch_create_tracked_queries_request_data.rb +399 -0
  168. data/lib/mencoro/models/batch_create_tracked_queries_result_resource.rb +163 -0
  169. data/lib/mencoro/models/batch_create_tracked_queries_result_resource_failed_inner.rb +183 -0
  170. data/lib/mencoro/models/batch_create_tracked_queries_result_resource_successful_inner.rb +174 -0
  171. data/lib/mencoro/models/batch_force_check_tracked_queries200_response.rb +162 -0
  172. data/lib/mencoro/models/batch_force_check_tracked_queries200_response_failed_inner.rb +165 -0
  173. data/lib/mencoro/models/batch_pause_tracked_queries200_response.rb +162 -0
  174. data/lib/mencoro/models/batch_pause_tracked_queries200_response_failed_inner.rb +165 -0
  175. data/lib/mencoro/models/batch_pause_tracked_queries200_response_successful_inner.rb +147 -0
  176. data/lib/mencoro/models/batch_resume_tracked_queries200_response.rb +162 -0
  177. data/lib/mencoro/models/batch_targets_request_data.rb +186 -0
  178. data/lib/mencoro/models/batch_write_outcome.rb +163 -0
  179. data/lib/mencoro/models/batch_write_outcome_failed_inner.rb +166 -0
  180. data/lib/mencoro/models/brand_profile_resource.rb +235 -0
  181. data/lib/mencoro/models/bulk_add_clusters_to_tracked_queries200_response.rb +162 -0
  182. data/lib/mencoro/models/bulk_add_clusters_to_tracked_queries_request.rb +218 -0
  183. data/lib/mencoro/models/bulk_remove_clusters_from_tracked_queries200_response.rb +162 -0
  184. data/lib/mencoro/models/bulk_remove_clusters_from_tracked_queries_request.rb +218 -0
  185. data/lib/mencoro/models/change_member_role_request.rb +181 -0
  186. data/lib/mencoro/models/change_tracked_query_check_frequency_request_data.rb +190 -0
  187. data/lib/mencoro/models/change_tracked_query_passes_request_data.rb +184 -0
  188. data/lib/mencoro/models/citation_resource.rb +306 -0
  189. data/lib/mencoro/models/cluster_membership_request_data.rb +186 -0
  190. data/lib/mencoro/models/competitor_resource.rb +250 -0
  191. data/lib/mencoro/models/create_competitor_request.rb +247 -0
  192. data/lib/mencoro/models/create_invitation200_response.rb +202 -0
  193. data/lib/mencoro/models/create_invitation201_response.rb +347 -0
  194. data/lib/mencoro/models/create_invitation_request.rb +192 -0
  195. data/lib/mencoro/models/create_organization201_response.rb +166 -0
  196. data/lib/mencoro/models/create_organization_request.rb +175 -0
  197. data/lib/mencoro/models/create_project_request.rb +307 -0
  198. data/lib/mencoro/models/create_project_request_competitors_inner.rb +256 -0
  199. data/lib/mencoro/models/create_query_cluster409_response.rb +165 -0
  200. data/lib/mencoro/models/create_query_cluster_request.rb +167 -0
  201. data/lib/mencoro/models/delete_query_cluster200_response.rb +168 -0
  202. data/lib/mencoro/models/entitlements_resource.rb +328 -0
  203. data/lib/mencoro/models/get_available_filters200_response.rb +173 -0
  204. data/lib/mencoro/models/get_available_filters200_response_clusters_inner.rb +157 -0
  205. data/lib/mencoro/models/get_me_stats200_response.rb +156 -0
  206. data/lib/mencoro/models/get_me_stats200_response_organizations.rb +167 -0
  207. data/lib/mencoro/models/get_me_stats200_response_projects.rb +196 -0
  208. data/lib/mencoro/models/get_membership_stats200_response.rb +322 -0
  209. data/lib/mencoro/models/get_mention_samples400_response.rb +231 -0
  210. data/lib/mencoro/models/get_mention_samples400_response_details_value_inner.rb +168 -0
  211. data/lib/mencoro/models/get_metric_glossary200_response.rb +149 -0
  212. data/lib/mencoro/models/get_metric_glossary200_response_metrics_inner.rb +240 -0
  213. data/lib/mencoro/models/get_organization_overview200_response.rb +158 -0
  214. data/lib/mencoro/models/get_organization_overview200_response_aggregate.rb +209 -0
  215. data/lib/mencoro/models/get_organization_overview200_response_projects_inner.rb +218 -0
  216. data/lib/mencoro/models/get_organization_stats200_response.rb +165 -0
  217. data/lib/mencoro/models/get_organization_stats200_response_invitations.rb +167 -0
  218. data/lib/mencoro/models/get_organization_stats200_response_members.rb +167 -0
  219. data/lib/mencoro/models/get_organization_stats200_response_projects.rb +196 -0
  220. data/lib/mencoro/models/get_share_of_voice_formula200_response.rb +182 -0
  221. data/lib/mencoro/models/get_tracking_coverage200_response.rb +209 -0
  222. data/lib/mencoro/models/get_tracking_coverage200_response_sample_inner.rb +229 -0
  223. data/lib/mencoro/models/invitation_resource.rb +331 -0
  224. data/lib/mencoro/models/keyword_listing_resource.rb +798 -0
  225. data/lib/mencoro/models/keyword_listing_resource_mention_type_counts.rb +184 -0
  226. data/lib/mencoro/models/list_ai_responses200_response.rb +159 -0
  227. data/lib/mencoro/models/list_competitors200_response.rb +159 -0
  228. data/lib/mencoro/models/list_invitations200_response.rb +158 -0
  229. data/lib/mencoro/models/list_keyword_listings200_response.rb +180 -0
  230. data/lib/mencoro/models/list_members200_response.rb +158 -0
  231. data/lib/mencoro/models/list_organizations200_response.rb +158 -0
  232. data/lib/mencoro/models/list_projects200_response.rb +159 -0
  233. data/lib/mencoro/models/list_query_clusters200_response.rb +159 -0
  234. data/lib/mencoro/models/list_search_snapshots200_response.rb +159 -0
  235. data/lib/mencoro/models/list_shopping_snapshots200_response.rb +159 -0
  236. data/lib/mencoro/models/me_resource.rb +394 -0
  237. data/lib/mencoro/models/member_resource.rb +322 -0
  238. data/lib/mencoro/models/operation_effect.rb +204 -0
  239. data/lib/mencoro/models/organization_resource.rb +326 -0
  240. data/lib/mencoro/models/preview_organization_operation200_response.rb +236 -0
  241. data/lib/mencoro/models/preview_organization_operation200_response_organization.rb +158 -0
  242. data/lib/mencoro/models/preview_organization_operation_request.rb +213 -0
  243. data/lib/mencoro/models/project_detail_resource.rb +380 -0
  244. data/lib/mencoro/models/project_detail_resource_competitors_inner.rb +178 -0
  245. data/lib/mencoro/models/project_resource.rb +422 -0
  246. data/lib/mencoro/models/projected_monthly_checks_resource.rb +211 -0
  247. data/lib/mencoro/models/query_cluster_resource.rb +229 -0
  248. data/lib/mencoro/models/report_ai_response_request.rb +227 -0
  249. data/lib/mencoro/models/search_result_resource.rb +284 -0
  250. data/lib/mencoro/models/search_snapshot_resource.rb +302 -0
  251. data/lib/mencoro/models/search_tracked_queries200_response.rb +158 -0
  252. data/lib/mencoro/models/shopping_offer_resource.rb +381 -0
  253. data/lib/mencoro/models/shopping_snapshot_resource.rb +302 -0
  254. data/lib/mencoro/models/start_brand_discovery_job_request.rb +185 -0
  255. data/lib/mencoro/models/start_brand_name_suggestion_job_request.rb +287 -0
  256. data/lib/mencoro/models/start_clustering_job_request_data.rb +249 -0
  257. data/lib/mencoro/models/start_keyword_discovery_job_request.rb +266 -0
  258. data/lib/mencoro/models/start_prompt_discovery_job_request.rb +276 -0
  259. data/lib/mencoro/models/submitted_checks_resource.rb +195 -0
  260. data/lib/mencoro/models/subscription_resource.rb +362 -0
  261. data/lib/mencoro/models/tracked_query_count_resource.rb +193 -0
  262. data/lib/mencoro/models/tracked_query_detail_resource.rb +440 -0
  263. data/lib/mencoro/models/tracked_query_resource.rb +492 -0
  264. data/lib/mencoro/models/tracked_query_usage_resource.rb +175 -0
  265. data/lib/mencoro/models/update_organization_request.rb +195 -0
  266. data/lib/mencoro/models/update_project_brand_profile_request.rb +218 -0
  267. data/lib/mencoro/models/update_project_request.rb +182 -0
  268. data/lib/mencoro/version.rb +15 -0
  269. data/lib/mencoro.rb +169 -0
  270. data/mencoro.gemspec +41 -0
  271. data/spec/api/account_api_spec.rb +57 -0
  272. data/spec/api/analytics_api_spec.rb +318 -0
  273. data/spec/api/billing_api_spec.rb +47 -0
  274. data/spec/api/captures_api_spec.rb +93 -0
  275. data/spec/api/clusters_api_spec.rb +126 -0
  276. data/spec/api/discovery_api_spec.rb +94 -0
  277. data/spec/api/invitations_api_spec.rb +83 -0
  278. data/spec/api/jobs_api_spec.rb +48 -0
  279. data/spec/api/members_api_spec.rb +111 -0
  280. data/spec/api/organization_operations_api_spec.rb +47 -0
  281. data/spec/api/organizations_api_spec.rb +181 -0
  282. data/spec/api/projects_api_spec.rb +229 -0
  283. data/spec/api/tracked_queries_api_spec.rb +344 -0
  284. data/spec/models/accepted_job_resource_spec.rb +48 -0
  285. data/spec/models/ai_response_report_resource_spec.rb +70 -0
  286. data/spec/models/ai_response_resource_spec.rb +90 -0
  287. data/spec/models/apply_clustering_job_outcome_clusters_inner_spec.rb +48 -0
  288. data/spec/models/apply_clustering_job_outcome_failed_inner_spec.rb +48 -0
  289. data/spec/models/apply_clustering_job_outcome_skipped_clusters_inner_spec.rb +42 -0
  290. data/spec/models/apply_clustering_job_outcome_spec.rb +60 -0
  291. data/spec/models/apply_clustering_job_outcome_successful_inner_spec.rb +42 -0
  292. data/spec/models/async_job_resource_spec.rb +62 -0
  293. data/spec/models/batch_change_tracked_query_check_frequency_request_data_spec.rb +46 -0
  294. data/spec/models/batch_change_tracked_query_passes_request_data_spec.rb +42 -0
  295. data/spec/models/batch_create_query_clusters_outcome_failed_inner_spec.rb +48 -0
  296. data/spec/models/batch_create_query_clusters_outcome_spec.rb +42 -0
  297. data/spec/models/batch_create_query_clusters_outcome_successful_inner_spec.rb +42 -0
  298. data/spec/models/batch_create_query_clusters_request_data_spec.rb +36 -0
  299. data/spec/models/batch_create_tracked_queries_request_data_spec.rb +80 -0
  300. data/spec/models/batch_create_tracked_queries_result_resource_failed_inner_spec.rb +60 -0
  301. data/spec/models/batch_create_tracked_queries_result_resource_spec.rb +42 -0
  302. data/spec/models/batch_create_tracked_queries_result_resource_successful_inner_spec.rb +54 -0
  303. data/spec/models/batch_force_check_tracked_queries200_response_failed_inner_spec.rb +48 -0
  304. data/spec/models/batch_force_check_tracked_queries200_response_spec.rb +42 -0
  305. data/spec/models/batch_pause_tracked_queries200_response_failed_inner_spec.rb +48 -0
  306. data/spec/models/batch_pause_tracked_queries200_response_spec.rb +42 -0
  307. data/spec/models/batch_pause_tracked_queries200_response_successful_inner_spec.rb +36 -0
  308. data/spec/models/batch_resume_tracked_queries200_response_spec.rb +42 -0
  309. data/spec/models/batch_targets_request_data_spec.rb +36 -0
  310. data/spec/models/batch_write_outcome_failed_inner_spec.rb +48 -0
  311. data/spec/models/batch_write_outcome_spec.rb +42 -0
  312. data/spec/models/brand_profile_resource_spec.rb +54 -0
  313. data/spec/models/bulk_add_clusters_to_tracked_queries200_response_spec.rb +42 -0
  314. data/spec/models/bulk_add_clusters_to_tracked_queries_request_spec.rb +42 -0
  315. data/spec/models/bulk_remove_clusters_from_tracked_queries200_response_spec.rb +42 -0
  316. data/spec/models/bulk_remove_clusters_from_tracked_queries_request_spec.rb +42 -0
  317. data/spec/models/change_member_role_request_spec.rb +40 -0
  318. data/spec/models/change_tracked_query_check_frequency_request_data_spec.rb +40 -0
  319. data/spec/models/change_tracked_query_passes_request_data_spec.rb +36 -0
  320. data/spec/models/citation_resource_spec.rb +90 -0
  321. data/spec/models/cluster_membership_request_data_spec.rb +36 -0
  322. data/spec/models/competitor_resource_spec.rb +54 -0
  323. data/spec/models/create_competitor_request_spec.rb +48 -0
  324. data/spec/models/create_invitation200_response_spec.rb +52 -0
  325. data/spec/models/create_invitation201_response_spec.rb +86 -0
  326. data/spec/models/create_invitation_request_spec.rb +46 -0
  327. data/spec/models/create_organization201_response_spec.rb +48 -0
  328. data/spec/models/create_organization_request_spec.rb +36 -0
  329. data/spec/models/create_project_request_competitors_inner_spec.rb +48 -0
  330. data/spec/models/create_project_request_spec.rb +54 -0
  331. data/spec/models/create_query_cluster409_response_spec.rb +48 -0
  332. data/spec/models/create_query_cluster_request_spec.rb +36 -0
  333. data/spec/models/delete_query_cluster200_response_spec.rb +48 -0
  334. data/spec/models/entitlements_resource_spec.rb +104 -0
  335. data/spec/models/get_available_filters200_response_clusters_inner_spec.rb +42 -0
  336. data/spec/models/get_available_filters200_response_spec.rb +48 -0
  337. data/spec/models/get_me_stats200_response_organizations_spec.rb +36 -0
  338. data/spec/models/get_me_stats200_response_projects_spec.rb +42 -0
  339. data/spec/models/get_me_stats200_response_spec.rb +42 -0
  340. data/spec/models/get_membership_stats200_response_spec.rb +72 -0
  341. data/spec/models/get_mention_samples400_response_details_value_inner_spec.rb +48 -0
  342. data/spec/models/get_mention_samples400_response_spec.rb +54 -0
  343. data/spec/models/get_metric_glossary200_response_metrics_inner_spec.rb +76 -0
  344. data/spec/models/get_metric_glossary200_response_spec.rb +36 -0
  345. data/spec/models/get_organization_overview200_response_aggregate_spec.rb +72 -0
  346. data/spec/models/get_organization_overview200_response_projects_inner_spec.rb +78 -0
  347. data/spec/models/get_organization_overview200_response_spec.rb +42 -0
  348. data/spec/models/get_organization_stats200_response_invitations_spec.rb +36 -0
  349. data/spec/models/get_organization_stats200_response_members_spec.rb +36 -0
  350. data/spec/models/get_organization_stats200_response_projects_spec.rb +42 -0
  351. data/spec/models/get_organization_stats200_response_spec.rb +48 -0
  352. data/spec/models/get_share_of_voice_formula200_response_spec.rb +54 -0
  353. data/spec/models/get_tracking_coverage200_response_sample_inner_spec.rb +70 -0
  354. data/spec/models/get_tracking_coverage200_response_spec.rb +72 -0
  355. data/spec/models/invitation_resource_spec.rb +80 -0
  356. data/spec/models/keyword_listing_resource_mention_type_counts_spec.rb +60 -0
  357. data/spec/models/keyword_listing_resource_spec.rb +262 -0
  358. data/spec/models/list_ai_responses200_response_spec.rb +42 -0
  359. data/spec/models/list_competitors200_response_spec.rb +42 -0
  360. data/spec/models/list_invitations200_response_spec.rb +42 -0
  361. data/spec/models/list_keyword_listings200_response_spec.rb +54 -0
  362. data/spec/models/list_members200_response_spec.rb +42 -0
  363. data/spec/models/list_organizations200_response_spec.rb +42 -0
  364. data/spec/models/list_projects200_response_spec.rb +42 -0
  365. data/spec/models/list_query_clusters200_response_spec.rb +42 -0
  366. data/spec/models/list_search_snapshots200_response_spec.rb +42 -0
  367. data/spec/models/list_shopping_snapshots200_response_spec.rb +42 -0
  368. data/spec/models/me_resource_spec.rb +92 -0
  369. data/spec/models/member_resource_spec.rb +74 -0
  370. data/spec/models/operation_effect_spec.rb +48 -0
  371. data/spec/models/organization_resource_spec.rb +86 -0
  372. data/spec/models/preview_organization_operation200_response_organization_spec.rb +42 -0
  373. data/spec/models/preview_organization_operation200_response_spec.rb +84 -0
  374. data/spec/models/preview_organization_operation_request_spec.rb +58 -0
  375. data/spec/models/project_detail_resource_competitors_inner_spec.rb +54 -0
  376. data/spec/models/project_detail_resource_spec.rb +82 -0
  377. data/spec/models/project_resource_spec.rb +136 -0
  378. data/spec/models/projected_monthly_checks_resource_spec.rb +42 -0
  379. data/spec/models/query_cluster_resource_spec.rb +48 -0
  380. data/spec/models/report_ai_response_request_spec.rb +52 -0
  381. data/spec/models/search_result_resource_spec.rb +78 -0
  382. data/spec/models/search_snapshot_resource_spec.rb +66 -0
  383. data/spec/models/search_tracked_queries200_response_spec.rb +42 -0
  384. data/spec/models/shopping_offer_resource_spec.rb +96 -0
  385. data/spec/models/shopping_snapshot_resource_spec.rb +66 -0
  386. data/spec/models/start_brand_discovery_job_request_spec.rb +42 -0
  387. data/spec/models/start_brand_name_suggestion_job_request_spec.rb +54 -0
  388. data/spec/models/start_clustering_job_request_data_spec.rb +52 -0
  389. data/spec/models/start_keyword_discovery_job_request_spec.rb +54 -0
  390. data/spec/models/start_prompt_discovery_job_request_spec.rb +54 -0
  391. data/spec/models/submitted_checks_resource_spec.rb +42 -0
  392. data/spec/models/subscription_resource_spec.rb +120 -0
  393. data/spec/models/tracked_query_count_resource_spec.rb +42 -0
  394. data/spec/models/tracked_query_detail_resource_spec.rb +108 -0
  395. data/spec/models/tracked_query_resource_spec.rb +150 -0
  396. data/spec/models/tracked_query_usage_resource_spec.rb +36 -0
  397. data/spec/models/update_organization_request_spec.rb +48 -0
  398. data/spec/models/update_project_brand_profile_request_spec.rb +42 -0
  399. data/spec/models/update_project_request_spec.rb +36 -0
  400. data/spec/spec_helper.rb +111 -0
  401. metadata +641 -0
@@ -0,0 +1,1549 @@
1
+ # Mencoro::TrackedQueriesApi
2
+
3
+ All URIs are relative to *https://api.mencoro.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**add_clusters_to_tracked_query**](TrackedQueriesApi.md#add_clusters_to_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/clusters | Add a tracked query to clusters |
8
+ | [**batch_change_tracked_queries_check_frequency**](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 |
9
+ | [**batch_change_tracked_queries_n_passes**](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 |
10
+ | [**batch_create_tracked_queries**](TrackedQueriesApi.md#batch_create_tracked_queries) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries | Create tracked queries |
11
+ | [**batch_force_check_tracked_queries**](TrackedQueriesApi.md#batch_force_check_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/check | Check several tracked queries now |
12
+ | [**batch_pause_tracked_queries**](TrackedQueriesApi.md#batch_pause_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/pause | Pause several tracked queries |
13
+ | [**batch_resume_tracked_queries**](TrackedQueriesApi.md#batch_resume_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/resume | Resume several tracked queries |
14
+ | [**bulk_add_clusters_to_tracked_queries**](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 |
15
+ | [**bulk_delete_tracked_queries**](TrackedQueriesApi.md#bulk_delete_tracked_queries) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk-delete | Delete tracked queries |
16
+ | [**bulk_remove_clusters_from_tracked_queries**](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 |
17
+ | [**change_tracked_query_check_frequency**](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 |
18
+ | [**change_tracked_query_n_passes**](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 |
19
+ | [**count_tracked_queries**](TrackedQueriesApi.md#count_tracked_queries) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/count | Count a project's tracked queries and price checking them |
20
+ | [**force_check_all_active_tracked_queries**](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 |
21
+ | [**get_tracked_query**](TrackedQueriesApi.md#get_tracked_query) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId} | Get a tracked query |
22
+ | [**pause_tracked_query**](TrackedQueriesApi.md#pause_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/pause | Pause a tracked query |
23
+ | [**remove_clusters_from_tracked_query**](TrackedQueriesApi.md#remove_clusters_from_tracked_query) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/clusters | Remove a tracked query from clusters |
24
+ | [**report_ai_response**](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 |
25
+ | [**resume_tracked_query**](TrackedQueriesApi.md#resume_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/resume | Resume a tracked query |
26
+ | [**search_tracked_queries**](TrackedQueriesApi.md#search_tracked_queries) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries | Search a project's tracked queries |
27
+
28
+
29
+ ## add_clusters_to_tracked_query
30
+
31
+ > <TrackedQueryDetailResource> add_clusters_to_tracked_query(organization_id, project_id, tracked_query_id, idempotency_key, cluster_membership_request_data)
32
+
33
+ Add a tracked query to clusters
34
+
35
+ Minimum role: manager. Adds the tracked query to every cluster named in \"queryClusterIds\" and answers with the query in its new state. Membership is a set: a cluster the query already belongs to is skipped, not reported as an error, and the response still lists it. Clusters the query belongs to and this call does not name are left alone — this adds, it does not replace the membership. Every cluster must belong to the project in the path; one that does not is rejected with its field named, and nothing is written. The \"Idempotency-Key\" header is required, and a repeat of the same key and body returns the recorded answer without adding anything again.
36
+
37
+ ### Examples
38
+
39
+ ```ruby
40
+ require 'time'
41
+ require 'mencoro'
42
+ # setup authorization
43
+ Mencoro.configure do |config|
44
+ # Configure Bearer authorization: ApiKey
45
+ config.access_token = 'YOUR_BEARER_TOKEN'
46
+ end
47
+
48
+ api_instance = Mencoro::TrackedQueriesApi.new
49
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
50
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
51
+ tracked_query_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the project in the path.
52
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation, so a lost response can be retried without repeating the write.
53
+ cluster_membership_request_data = Mencoro::ClusterMembershipRequestData.new({query_cluster_ids: ['query_cluster_ids_example']}) # ClusterMembershipRequestData |
54
+
55
+ begin
56
+ # Add a tracked query to clusters
57
+ result = api_instance.add_clusters_to_tracked_query(organization_id, project_id, tracked_query_id, idempotency_key, cluster_membership_request_data)
58
+ p result
59
+ rescue Mencoro::ApiError => e
60
+ puts "Error when calling TrackedQueriesApi->add_clusters_to_tracked_query: #{e}"
61
+ end
62
+ ```
63
+
64
+ #### Using the add_clusters_to_tracked_query_with_http_info variant
65
+
66
+ This returns an Array which contains the response data, status code and headers.
67
+
68
+ > <Array(<TrackedQueryDetailResource>, Integer, Hash)> add_clusters_to_tracked_query_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key, cluster_membership_request_data)
69
+
70
+ ```ruby
71
+ begin
72
+ # Add a tracked query to clusters
73
+ data, status_code, headers = api_instance.add_clusters_to_tracked_query_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key, cluster_membership_request_data)
74
+ p status_code # => 2xx
75
+ p headers # => { ... }
76
+ p data # => <TrackedQueryDetailResource>
77
+ rescue Mencoro::ApiError => e
78
+ puts "Error when calling TrackedQueriesApi->add_clusters_to_tracked_query_with_http_info: #{e}"
79
+ end
80
+ ```
81
+
82
+ ### Parameters
83
+
84
+ | Name | Type | Description | Notes |
85
+ | ---- | ---- | ----------- | ----- |
86
+ | **organization_id** | **String** | | |
87
+ | **project_id** | **String** | | |
88
+ | **tracked_query_id** | **String** | Must belong to the project in the path. | |
89
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation, so a lost response can be retried without repeating the write. | |
90
+ | **cluster_membership_request_data** | [**ClusterMembershipRequestData**](ClusterMembershipRequestData.md) | | |
91
+
92
+ ### Return type
93
+
94
+ [**TrackedQueryDetailResource**](TrackedQueryDetailResource.md)
95
+
96
+ ### Authorization
97
+
98
+ [ApiKey](../README.md#ApiKey)
99
+
100
+ ### HTTP request headers
101
+
102
+ - **Content-Type**: application/json
103
+ - **Accept**: application/json
104
+
105
+
106
+ ## batch_change_tracked_queries_check_frequency
107
+
108
+ > <BatchWriteOutcome> batch_change_tracked_queries_check_frequency(organization_id, project_id, idempotency_key, batch_change_tracked_query_check_frequency_request_data)
109
+
110
+ Change how often several tracked queries are checked
111
+
112
+ Minimum role: manager. Sets the same check frequency on every tracked query named in `ids`, at most 100 distinct ids per call. The organization must be active and the project must not be archived. Partial success: an id that is not a tracked query of this project — unknown, malformed, already deleted, or belonging to somewhere else — is reported under `failed` with `tracked_query_not_found` while the rest are changed, and the call still answers 200. Nothing is rolled back because an item failed. Setting the frequency a query already has is accepted and changes nothing. This does NOT run a check and does not reschedule one already in flight. It never changes more than the ids it is given: there is no \"change everything matching a filter\" mode. The Idempotency-Key header is required; a retry with the same key and the same body returns this same answer without applying anything again.
113
+
114
+ ### Examples
115
+
116
+ ```ruby
117
+ require 'time'
118
+ require 'mencoro'
119
+ # setup authorization
120
+ Mencoro.configure do |config|
121
+ # Configure Bearer authorization: ApiKey
122
+ config.access_token = 'YOUR_BEARER_TOKEN'
123
+ end
124
+
125
+ api_instance = Mencoro::TrackedQueriesApi.new
126
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
127
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
128
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation. Replaying it returns the first answer instead of applying anything again.
129
+ batch_change_tracked_query_check_frequency_request_data = Mencoro::BatchChangeTrackedQueryCheckFrequencyRequestData.new({ids: ['ids_example'], check_frequency: 'daily'}) # BatchChangeTrackedQueryCheckFrequencyRequestData |
130
+
131
+ begin
132
+ # Change how often several tracked queries are checked
133
+ result = api_instance.batch_change_tracked_queries_check_frequency(organization_id, project_id, idempotency_key, batch_change_tracked_query_check_frequency_request_data)
134
+ p result
135
+ rescue Mencoro::ApiError => e
136
+ puts "Error when calling TrackedQueriesApi->batch_change_tracked_queries_check_frequency: #{e}"
137
+ end
138
+ ```
139
+
140
+ #### Using the batch_change_tracked_queries_check_frequency_with_http_info variant
141
+
142
+ This returns an Array which contains the response data, status code and headers.
143
+
144
+ > <Array(<BatchWriteOutcome>, Integer, Hash)> batch_change_tracked_queries_check_frequency_with_http_info(organization_id, project_id, idempotency_key, batch_change_tracked_query_check_frequency_request_data)
145
+
146
+ ```ruby
147
+ begin
148
+ # Change how often several tracked queries are checked
149
+ data, status_code, headers = api_instance.batch_change_tracked_queries_check_frequency_with_http_info(organization_id, project_id, idempotency_key, batch_change_tracked_query_check_frequency_request_data)
150
+ p status_code # => 2xx
151
+ p headers # => { ... }
152
+ p data # => <BatchWriteOutcome>
153
+ rescue Mencoro::ApiError => e
154
+ puts "Error when calling TrackedQueriesApi->batch_change_tracked_queries_check_frequency_with_http_info: #{e}"
155
+ end
156
+ ```
157
+
158
+ ### Parameters
159
+
160
+ | Name | Type | Description | Notes |
161
+ | ---- | ---- | ----------- | ----- |
162
+ | **organization_id** | **String** | | |
163
+ | **project_id** | **String** | | |
164
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation. Replaying it returns the first answer instead of applying anything again. | |
165
+ | **batch_change_tracked_query_check_frequency_request_data** | [**BatchChangeTrackedQueryCheckFrequencyRequestData**](BatchChangeTrackedQueryCheckFrequencyRequestData.md) | | |
166
+
167
+ ### Return type
168
+
169
+ [**BatchWriteOutcome**](BatchWriteOutcome.md)
170
+
171
+ ### Authorization
172
+
173
+ [ApiKey](../README.md#ApiKey)
174
+
175
+ ### HTTP request headers
176
+
177
+ - **Content-Type**: application/json
178
+ - **Accept**: application/json
179
+
180
+
181
+ ## batch_change_tracked_queries_n_passes
182
+
183
+ > <BatchWriteOutcome> batch_change_tracked_queries_n_passes(organization_id, project_id, idempotency_key, batch_change_tracked_query_passes_request_data)
184
+
185
+ Change how many passes several tracked queries run per check
186
+
187
+ Minimum role: manager. Sets the same passes-per-check on every tracked query named in `ids`, at most 100 distinct ids per call. The organization must be active and the project must not be archived. Partial success, and two distinct reasons appear under `failed`: an id that is not a tracked query of this project answers `tracked_query_not_found`, and a `google_serp` or `google_shopping` query asked for more than one pass answers `n_passes_not_supported_for_engine` — those engines run a single pass. Both leave the rest of the batch changed and the call still answers 200. Setting the value back to 1 is always allowed, so a batch that lowers sampling never fails on engine grounds. This does NOT run a check and does not change history already captured. More passes cost proportionally more of the plan's check budget. It never changes more than the ids it is given: there is no \"change everything matching a filter\" mode. The Idempotency-Key header is required; a retry with the same key and the same body returns this same answer without applying anything again.
188
+
189
+ ### Examples
190
+
191
+ ```ruby
192
+ require 'time'
193
+ require 'mencoro'
194
+ # setup authorization
195
+ Mencoro.configure do |config|
196
+ # Configure Bearer authorization: ApiKey
197
+ config.access_token = 'YOUR_BEARER_TOKEN'
198
+ end
199
+
200
+ api_instance = Mencoro::TrackedQueriesApi.new
201
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
202
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
203
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation. Replaying it returns the first answer instead of applying anything again.
204
+ batch_change_tracked_query_passes_request_data = Mencoro::BatchChangeTrackedQueryPassesRequestData.new({ids: ['ids_example'], n_passes: 37}) # BatchChangeTrackedQueryPassesRequestData |
205
+
206
+ begin
207
+ # Change how many passes several tracked queries run per check
208
+ result = api_instance.batch_change_tracked_queries_n_passes(organization_id, project_id, idempotency_key, batch_change_tracked_query_passes_request_data)
209
+ p result
210
+ rescue Mencoro::ApiError => e
211
+ puts "Error when calling TrackedQueriesApi->batch_change_tracked_queries_n_passes: #{e}"
212
+ end
213
+ ```
214
+
215
+ #### Using the batch_change_tracked_queries_n_passes_with_http_info variant
216
+
217
+ This returns an Array which contains the response data, status code and headers.
218
+
219
+ > <Array(<BatchWriteOutcome>, Integer, Hash)> batch_change_tracked_queries_n_passes_with_http_info(organization_id, project_id, idempotency_key, batch_change_tracked_query_passes_request_data)
220
+
221
+ ```ruby
222
+ begin
223
+ # Change how many passes several tracked queries run per check
224
+ data, status_code, headers = api_instance.batch_change_tracked_queries_n_passes_with_http_info(organization_id, project_id, idempotency_key, batch_change_tracked_query_passes_request_data)
225
+ p status_code # => 2xx
226
+ p headers # => { ... }
227
+ p data # => <BatchWriteOutcome>
228
+ rescue Mencoro::ApiError => e
229
+ puts "Error when calling TrackedQueriesApi->batch_change_tracked_queries_n_passes_with_http_info: #{e}"
230
+ end
231
+ ```
232
+
233
+ ### Parameters
234
+
235
+ | Name | Type | Description | Notes |
236
+ | ---- | ---- | ----------- | ----- |
237
+ | **organization_id** | **String** | | |
238
+ | **project_id** | **String** | | |
239
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation. Replaying it returns the first answer instead of applying anything again. | |
240
+ | **batch_change_tracked_query_passes_request_data** | [**BatchChangeTrackedQueryPassesRequestData**](BatchChangeTrackedQueryPassesRequestData.md) | | |
241
+
242
+ ### Return type
243
+
244
+ [**BatchWriteOutcome**](BatchWriteOutcome.md)
245
+
246
+ ### Authorization
247
+
248
+ [ApiKey](../README.md#ApiKey)
249
+
250
+ ### HTTP request headers
251
+
252
+ - **Content-Type**: application/json
253
+ - **Accept**: application/json
254
+
255
+
256
+ ## batch_create_tracked_queries
257
+
258
+ > <BatchCreateTrackedQueriesResultResource> batch_create_tracked_queries(organization_id, project_id, idempotency_key, batch_create_tracked_queries_request_data)
259
+
260
+ Create tracked queries
261
+
262
+ Minimum role: manager. Creates the cross product of `queryTexts` x `engines` x `countries`: three texts, two engines and two countries create twelve tracked queries, not three. At most 100 combinations per call. The organization must be active and the project must not be archived. Partial success: the response lists, per combination, either the id it was created under or why nothing was created for it, and the status code never reports item-level outcomes. A combination the project already tracks is NOT created again and NOT re-identified — it appears under `failed` with `tracked_query_already_exists`, keeps the id it already had, and has any `queryClusterIds` in this request merged into it. Query text is normalised before it is compared and stored (lower-cased, whitespace collapsed, leading list markers stripped), so two texts differing only in those respects are one tracked query: the first of them owns the outcome and every later one appears under `failed` with `duplicate_combination_in_request`, naming the entry it repeats. `nPasses` applies to AI engines only: `google_serp` and `google_shopping` rows are always created with one pass, whatever is sent. Google AI Mode is unavailable in a few countries and those combinations are reported under `failed` rather than created. Creating a tracked query does not run a check: the first check happens on the normal schedule for the `checkFrequency` chosen. The Idempotency-Key header is required; a retry with the same key and the same body returns this same answer without creating anything again.
263
+
264
+ ### Examples
265
+
266
+ ```ruby
267
+ require 'time'
268
+ require 'mencoro'
269
+ # setup authorization
270
+ Mencoro.configure do |config|
271
+ # Configure Bearer authorization: ApiKey
272
+ config.access_token = 'YOUR_BEARER_TOKEN'
273
+ end
274
+
275
+ api_instance = Mencoro::TrackedQueriesApi.new
276
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
277
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
278
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation. Replaying it returns the first answer instead of creating anything again.
279
+ batch_create_tracked_queries_request_data = Mencoro::BatchCreateTrackedQueriesRequestData.new({query_texts: ['query_texts_example'], engines: ['chatgpt'], countries: ['countries_example'], check_frequency: 'daily', n_passes: 37, query_cluster_ids: ['query_cluster_ids_example']}) # BatchCreateTrackedQueriesRequestData |
280
+
281
+ begin
282
+ # Create tracked queries
283
+ result = api_instance.batch_create_tracked_queries(organization_id, project_id, idempotency_key, batch_create_tracked_queries_request_data)
284
+ p result
285
+ rescue Mencoro::ApiError => e
286
+ puts "Error when calling TrackedQueriesApi->batch_create_tracked_queries: #{e}"
287
+ end
288
+ ```
289
+
290
+ #### Using the batch_create_tracked_queries_with_http_info variant
291
+
292
+ This returns an Array which contains the response data, status code and headers.
293
+
294
+ > <Array(<BatchCreateTrackedQueriesResultResource>, Integer, Hash)> batch_create_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_create_tracked_queries_request_data)
295
+
296
+ ```ruby
297
+ begin
298
+ # Create tracked queries
299
+ data, status_code, headers = api_instance.batch_create_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_create_tracked_queries_request_data)
300
+ p status_code # => 2xx
301
+ p headers # => { ... }
302
+ p data # => <BatchCreateTrackedQueriesResultResource>
303
+ rescue Mencoro::ApiError => e
304
+ puts "Error when calling TrackedQueriesApi->batch_create_tracked_queries_with_http_info: #{e}"
305
+ end
306
+ ```
307
+
308
+ ### Parameters
309
+
310
+ | Name | Type | Description | Notes |
311
+ | ---- | ---- | ----------- | ----- |
312
+ | **organization_id** | **String** | | |
313
+ | **project_id** | **String** | | |
314
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation. Replaying it returns the first answer instead of creating anything again. | |
315
+ | **batch_create_tracked_queries_request_data** | [**BatchCreateTrackedQueriesRequestData**](BatchCreateTrackedQueriesRequestData.md) | | |
316
+
317
+ ### Return type
318
+
319
+ [**BatchCreateTrackedQueriesResultResource**](BatchCreateTrackedQueriesResultResource.md)
320
+
321
+ ### Authorization
322
+
323
+ [ApiKey](../README.md#ApiKey)
324
+
325
+ ### HTTP request headers
326
+
327
+ - **Content-Type**: application/json
328
+ - **Accept**: application/json
329
+
330
+
331
+ ## batch_force_check_tracked_queries
332
+
333
+ > <BatchForceCheckTrackedQueries200Response> batch_force_check_tracked_queries(organization_id, project_id, idempotency_key, batch_targets_request_data)
334
+
335
+ Check several tracked queries now
336
+
337
+ Minimum role: manager. Asks for a fresh check of up to 100 named tracked queries straight away, ignoring how recently each was last checked. Answers 200 with per-item results and NO job id: a check that is already in flight for a query is reused rather than started again, so there is no id this operation could hand back that is guaranteed to exist. Follow progress on the tracked query itself — its lastCheckedAt advances when the check completes. A successful item means the check was accepted for submission with budget available for it at that moment; it does not mean the check has run. A checked query costs one budget unit per pass (nPasses), and items that do not fit the remaining budget are reported as failed with `check_budget_forecast_exhausted`, or `subscription_not_found` when the organization has no entitled subscription — they are never reported as successful. That budget figure is a forecast for this batch, and a pessimistic one: a tracked query already being checked is joined to the check in flight and costs nothing, but it is still debited here, so an item refused this way may have fitted. Resubmit it in a later batch rather than treating the refusal as a statement about your subscription. A paused query is reported as failed with `tracked_query_already_paused`: paused queries are never checked. An id that is not a tracked query of this project is reported as failed with `tracked_query_not_found`, exactly as an id that does not exist. Requires an Idempotency-Key header; a retry must repeat the same ids in the same order.
338
+
339
+ ### Examples
340
+
341
+ ```ruby
342
+ require 'time'
343
+ require 'mencoro'
344
+ # setup authorization
345
+ Mencoro.configure do |config|
346
+ # Configure Bearer authorization: ApiKey
347
+ config.access_token = 'YOUR_BEARER_TOKEN'
348
+ end
349
+
350
+ api_instance = Mencoro::TrackedQueriesApi.new
351
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
352
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
353
+ idempotency_key = 'idempotency_key_example' # String | Repeating a request with the same key and the same ids answers with the first attempt's result instead of submitting again.
354
+ batch_targets_request_data = Mencoro::BatchTargetsRequestData.new({ids: ['ids_example']}) # BatchTargetsRequestData |
355
+
356
+ begin
357
+ # Check several tracked queries now
358
+ result = api_instance.batch_force_check_tracked_queries(organization_id, project_id, idempotency_key, batch_targets_request_data)
359
+ p result
360
+ rescue Mencoro::ApiError => e
361
+ puts "Error when calling TrackedQueriesApi->batch_force_check_tracked_queries: #{e}"
362
+ end
363
+ ```
364
+
365
+ #### Using the batch_force_check_tracked_queries_with_http_info variant
366
+
367
+ This returns an Array which contains the response data, status code and headers.
368
+
369
+ > <Array(<BatchForceCheckTrackedQueries200Response>, Integer, Hash)> batch_force_check_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_targets_request_data)
370
+
371
+ ```ruby
372
+ begin
373
+ # Check several tracked queries now
374
+ data, status_code, headers = api_instance.batch_force_check_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_targets_request_data)
375
+ p status_code # => 2xx
376
+ p headers # => { ... }
377
+ p data # => <BatchForceCheckTrackedQueries200Response>
378
+ rescue Mencoro::ApiError => e
379
+ puts "Error when calling TrackedQueriesApi->batch_force_check_tracked_queries_with_http_info: #{e}"
380
+ end
381
+ ```
382
+
383
+ ### Parameters
384
+
385
+ | Name | Type | Description | Notes |
386
+ | ---- | ---- | ----------- | ----- |
387
+ | **organization_id** | **String** | | |
388
+ | **project_id** | **String** | | |
389
+ | **idempotency_key** | **String** | Repeating a request with the same key and the same ids answers with the first attempt&#39;s result instead of submitting again. | |
390
+ | **batch_targets_request_data** | [**BatchTargetsRequestData**](BatchTargetsRequestData.md) | | |
391
+
392
+ ### Return type
393
+
394
+ [**BatchForceCheckTrackedQueries200Response**](BatchForceCheckTrackedQueries200Response.md)
395
+
396
+ ### Authorization
397
+
398
+ [ApiKey](../README.md#ApiKey)
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: application/json
403
+ - **Accept**: application/json
404
+
405
+
406
+ ## batch_pause_tracked_queries
407
+
408
+ > <BatchPauseTrackedQueries200Response> batch_pause_tracked_queries(organization_id, project_id, idempotency_key, batch_targets_request_data)
409
+
410
+ Pause several tracked queries
411
+
412
+ Minimum role: manager. Pauses up to 100 tracked queries of one project, each independently. Always answers 200 when the batch itself was processed: read `failed` to find out which items were not paused, never the status code. Items are never rolled back because a later one failed. An id that is already paused is reported as successful — pausing asserts a state, not a transition. An id that is not a tracked query of this project is reported as failed with `tracked_query_not_found`, exactly as an id that does not exist at all, and nothing is written for it. Pausing does not cancel a check that is already running. Requires an Idempotency-Key header; a retry must repeat the same ids in the same order to be recognised as a retry rather than refused as a reused key.
413
+
414
+ ### Examples
415
+
416
+ ```ruby
417
+ require 'time'
418
+ require 'mencoro'
419
+ # setup authorization
420
+ Mencoro.configure do |config|
421
+ # Configure Bearer authorization: ApiKey
422
+ config.access_token = 'YOUR_BEARER_TOKEN'
423
+ end
424
+
425
+ api_instance = Mencoro::TrackedQueriesApi.new
426
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
427
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
428
+ idempotency_key = 'idempotency_key_example' # String | Repeating a request with the same key and the same ids answers with the first attempt's result.
429
+ batch_targets_request_data = Mencoro::BatchTargetsRequestData.new({ids: ['ids_example']}) # BatchTargetsRequestData |
430
+
431
+ begin
432
+ # Pause several tracked queries
433
+ result = api_instance.batch_pause_tracked_queries(organization_id, project_id, idempotency_key, batch_targets_request_data)
434
+ p result
435
+ rescue Mencoro::ApiError => e
436
+ puts "Error when calling TrackedQueriesApi->batch_pause_tracked_queries: #{e}"
437
+ end
438
+ ```
439
+
440
+ #### Using the batch_pause_tracked_queries_with_http_info variant
441
+
442
+ This returns an Array which contains the response data, status code and headers.
443
+
444
+ > <Array(<BatchPauseTrackedQueries200Response>, Integer, Hash)> batch_pause_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_targets_request_data)
445
+
446
+ ```ruby
447
+ begin
448
+ # Pause several tracked queries
449
+ data, status_code, headers = api_instance.batch_pause_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_targets_request_data)
450
+ p status_code # => 2xx
451
+ p headers # => { ... }
452
+ p data # => <BatchPauseTrackedQueries200Response>
453
+ rescue Mencoro::ApiError => e
454
+ puts "Error when calling TrackedQueriesApi->batch_pause_tracked_queries_with_http_info: #{e}"
455
+ end
456
+ ```
457
+
458
+ ### Parameters
459
+
460
+ | Name | Type | Description | Notes |
461
+ | ---- | ---- | ----------- | ----- |
462
+ | **organization_id** | **String** | | |
463
+ | **project_id** | **String** | | |
464
+ | **idempotency_key** | **String** | Repeating a request with the same key and the same ids answers with the first attempt&#39;s result. | |
465
+ | **batch_targets_request_data** | [**BatchTargetsRequestData**](BatchTargetsRequestData.md) | | |
466
+
467
+ ### Return type
468
+
469
+ [**BatchPauseTrackedQueries200Response**](BatchPauseTrackedQueries200Response.md)
470
+
471
+ ### Authorization
472
+
473
+ [ApiKey](../README.md#ApiKey)
474
+
475
+ ### HTTP request headers
476
+
477
+ - **Content-Type**: application/json
478
+ - **Accept**: application/json
479
+
480
+
481
+ ## batch_resume_tracked_queries
482
+
483
+ > <BatchResumeTrackedQueries200Response> batch_resume_tracked_queries(organization_id, project_id, idempotency_key, batch_targets_request_data)
484
+
485
+ Resume several tracked queries
486
+
487
+ Minimum role: manager. Puts up to 100 paused tracked queries of one project back under the scheduler, each independently. Always answers 200 when the batch itself was processed: read `failed` to find out which items were not resumed, never the status code. Items are never rolled back because a later one failed. An id that is already active is reported as successful — resuming asserts a state, not a transition. An id that is not a tracked query of this project is reported as failed with `tracked_query_not_found`, exactly as an id that does not exist at all, and nothing is written for it. No check is run by this operation and nothing is back-filled for the time the queries spent paused. Requires an Idempotency-Key header; a retry must repeat the same ids in the same order to be recognised as a retry rather than refused as a reused key.
488
+
489
+ ### Examples
490
+
491
+ ```ruby
492
+ require 'time'
493
+ require 'mencoro'
494
+ # setup authorization
495
+ Mencoro.configure do |config|
496
+ # Configure Bearer authorization: ApiKey
497
+ config.access_token = 'YOUR_BEARER_TOKEN'
498
+ end
499
+
500
+ api_instance = Mencoro::TrackedQueriesApi.new
501
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
502
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
503
+ idempotency_key = 'idempotency_key_example' # String | Repeating a request with the same key and the same ids answers with the first attempt's result.
504
+ batch_targets_request_data = Mencoro::BatchTargetsRequestData.new({ids: ['ids_example']}) # BatchTargetsRequestData |
505
+
506
+ begin
507
+ # Resume several tracked queries
508
+ result = api_instance.batch_resume_tracked_queries(organization_id, project_id, idempotency_key, batch_targets_request_data)
509
+ p result
510
+ rescue Mencoro::ApiError => e
511
+ puts "Error when calling TrackedQueriesApi->batch_resume_tracked_queries: #{e}"
512
+ end
513
+ ```
514
+
515
+ #### Using the batch_resume_tracked_queries_with_http_info variant
516
+
517
+ This returns an Array which contains the response data, status code and headers.
518
+
519
+ > <Array(<BatchResumeTrackedQueries200Response>, Integer, Hash)> batch_resume_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_targets_request_data)
520
+
521
+ ```ruby
522
+ begin
523
+ # Resume several tracked queries
524
+ data, status_code, headers = api_instance.batch_resume_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_targets_request_data)
525
+ p status_code # => 2xx
526
+ p headers # => { ... }
527
+ p data # => <BatchResumeTrackedQueries200Response>
528
+ rescue Mencoro::ApiError => e
529
+ puts "Error when calling TrackedQueriesApi->batch_resume_tracked_queries_with_http_info: #{e}"
530
+ end
531
+ ```
532
+
533
+ ### Parameters
534
+
535
+ | Name | Type | Description | Notes |
536
+ | ---- | ---- | ----------- | ----- |
537
+ | **organization_id** | **String** | | |
538
+ | **project_id** | **String** | | |
539
+ | **idempotency_key** | **String** | Repeating a request with the same key and the same ids answers with the first attempt&#39;s result. | |
540
+ | **batch_targets_request_data** | [**BatchTargetsRequestData**](BatchTargetsRequestData.md) | | |
541
+
542
+ ### Return type
543
+
544
+ [**BatchResumeTrackedQueries200Response**](BatchResumeTrackedQueries200Response.md)
545
+
546
+ ### Authorization
547
+
548
+ [ApiKey](../README.md#ApiKey)
549
+
550
+ ### HTTP request headers
551
+
552
+ - **Content-Type**: application/json
553
+ - **Accept**: application/json
554
+
555
+
556
+ ## bulk_add_clusters_to_tracked_queries
557
+
558
+ > <BulkAddClustersToTrackedQueries200Response> bulk_add_clusters_to_tracked_queries(organization_id, project_id, idempotency_key, bulk_add_clusters_to_tracked_queries_request)
559
+
560
+ Add many tracked queries to clusters
561
+
562
+ Minimum role: manager. Adds every tracked query named in \"ids\" to every cluster named in \"queryClusterIds\". At most 100 distinct tracked queries per call; duplicates in \"ids\" are collapsed. Partial success: the answer is 200 with a per-item \"successful\" and \"failed\" list even when some items failed, nothing is rolled back, and an id that is not a tracked query of this project is reported as a failed item rather than dropped. Clusters not named are left alone — this adds, it does not replace membership. Every cluster must belong to the project in the path; one that does not is rejected with its field named and nothing is written at all. The \"Idempotency-Key\" header is required, and a repeat of the same key and body returns the recorded answer without running the batch again.
563
+
564
+ ### Examples
565
+
566
+ ```ruby
567
+ require 'time'
568
+ require 'mencoro'
569
+ # setup authorization
570
+ Mencoro.configure do |config|
571
+ # Configure Bearer authorization: ApiKey
572
+ config.access_token = 'YOUR_BEARER_TOKEN'
573
+ end
574
+
575
+ api_instance = Mencoro::TrackedQueriesApi.new
576
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
577
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
578
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation, so a lost response can be retried without repeating the batch.
579
+ bulk_add_clusters_to_tracked_queries_request = Mencoro::BulkAddClustersToTrackedQueriesRequest.new # BulkAddClustersToTrackedQueriesRequest |
580
+
581
+ begin
582
+ # Add many tracked queries to clusters
583
+ result = api_instance.bulk_add_clusters_to_tracked_queries(organization_id, project_id, idempotency_key, bulk_add_clusters_to_tracked_queries_request)
584
+ p result
585
+ rescue Mencoro::ApiError => e
586
+ puts "Error when calling TrackedQueriesApi->bulk_add_clusters_to_tracked_queries: #{e}"
587
+ end
588
+ ```
589
+
590
+ #### Using the bulk_add_clusters_to_tracked_queries_with_http_info variant
591
+
592
+ This returns an Array which contains the response data, status code and headers.
593
+
594
+ > <Array(<BulkAddClustersToTrackedQueries200Response>, Integer, Hash)> bulk_add_clusters_to_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, bulk_add_clusters_to_tracked_queries_request)
595
+
596
+ ```ruby
597
+ begin
598
+ # Add many tracked queries to clusters
599
+ data, status_code, headers = api_instance.bulk_add_clusters_to_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, bulk_add_clusters_to_tracked_queries_request)
600
+ p status_code # => 2xx
601
+ p headers # => { ... }
602
+ p data # => <BulkAddClustersToTrackedQueries200Response>
603
+ rescue Mencoro::ApiError => e
604
+ puts "Error when calling TrackedQueriesApi->bulk_add_clusters_to_tracked_queries_with_http_info: #{e}"
605
+ end
606
+ ```
607
+
608
+ ### Parameters
609
+
610
+ | Name | Type | Description | Notes |
611
+ | ---- | ---- | ----------- | ----- |
612
+ | **organization_id** | **String** | | |
613
+ | **project_id** | **String** | | |
614
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation, so a lost response can be retried without repeating the batch. | |
615
+ | **bulk_add_clusters_to_tracked_queries_request** | [**BulkAddClustersToTrackedQueriesRequest**](BulkAddClustersToTrackedQueriesRequest.md) | | |
616
+
617
+ ### Return type
618
+
619
+ [**BulkAddClustersToTrackedQueries200Response**](BulkAddClustersToTrackedQueries200Response.md)
620
+
621
+ ### Authorization
622
+
623
+ [ApiKey](../README.md#ApiKey)
624
+
625
+ ### HTTP request headers
626
+
627
+ - **Content-Type**: application/json
628
+ - **Accept**: application/json
629
+
630
+
631
+ ## bulk_delete_tracked_queries
632
+
633
+ > <BatchWriteOutcome> bulk_delete_tracked_queries(organization_id, project_id, idempotency_key, batch_targets_request_data)
634
+
635
+ Delete tracked queries
636
+
637
+ Minimum role: manager. Permanently deletes the tracked queries named in `ids`, at most 100 distinct ids per call. The organization must be active and the project must not be archived. Deletion is hard and cannot be undone: the tracked query is removed along with its captured answers, matches, search pages and rank history, and any check already in flight for it is cancelled. Those cascades run in the background, so a 200 means the tracked queries were deleted, not that every derived record has finished being purged. Partial success: an id that is not a tracked query of this project — unknown, malformed, already deleted, or belonging to somewhere else — is reported under `failed` with `tracked_query_not_found` while the rest are deleted. It never deletes more than the ids it is given: there is no \"delete everything matching a filter\" mode. The Idempotency-Key header is required; a retry with the same key and the same body returns this same answer without deleting anything again.
638
+
639
+ ### Examples
640
+
641
+ ```ruby
642
+ require 'time'
643
+ require 'mencoro'
644
+ # setup authorization
645
+ Mencoro.configure do |config|
646
+ # Configure Bearer authorization: ApiKey
647
+ config.access_token = 'YOUR_BEARER_TOKEN'
648
+ end
649
+
650
+ api_instance = Mencoro::TrackedQueriesApi.new
651
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
652
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
653
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation. Replaying it returns the first answer instead of deleting anything again.
654
+ batch_targets_request_data = Mencoro::BatchTargetsRequestData.new({ids: ['ids_example']}) # BatchTargetsRequestData |
655
+
656
+ begin
657
+ # Delete tracked queries
658
+ result = api_instance.bulk_delete_tracked_queries(organization_id, project_id, idempotency_key, batch_targets_request_data)
659
+ p result
660
+ rescue Mencoro::ApiError => e
661
+ puts "Error when calling TrackedQueriesApi->bulk_delete_tracked_queries: #{e}"
662
+ end
663
+ ```
664
+
665
+ #### Using the bulk_delete_tracked_queries_with_http_info variant
666
+
667
+ This returns an Array which contains the response data, status code and headers.
668
+
669
+ > <Array(<BatchWriteOutcome>, Integer, Hash)> bulk_delete_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_targets_request_data)
670
+
671
+ ```ruby
672
+ begin
673
+ # Delete tracked queries
674
+ data, status_code, headers = api_instance.bulk_delete_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, batch_targets_request_data)
675
+ p status_code # => 2xx
676
+ p headers # => { ... }
677
+ p data # => <BatchWriteOutcome>
678
+ rescue Mencoro::ApiError => e
679
+ puts "Error when calling TrackedQueriesApi->bulk_delete_tracked_queries_with_http_info: #{e}"
680
+ end
681
+ ```
682
+
683
+ ### Parameters
684
+
685
+ | Name | Type | Description | Notes |
686
+ | ---- | ---- | ----------- | ----- |
687
+ | **organization_id** | **String** | | |
688
+ | **project_id** | **String** | | |
689
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation. Replaying it returns the first answer instead of deleting anything again. | |
690
+ | **batch_targets_request_data** | [**BatchTargetsRequestData**](BatchTargetsRequestData.md) | | |
691
+
692
+ ### Return type
693
+
694
+ [**BatchWriteOutcome**](BatchWriteOutcome.md)
695
+
696
+ ### Authorization
697
+
698
+ [ApiKey](../README.md#ApiKey)
699
+
700
+ ### HTTP request headers
701
+
702
+ - **Content-Type**: application/json
703
+ - **Accept**: application/json
704
+
705
+
706
+ ## bulk_remove_clusters_from_tracked_queries
707
+
708
+ > <BulkRemoveClustersFromTrackedQueries200Response> bulk_remove_clusters_from_tracked_queries(organization_id, project_id, idempotency_key, bulk_remove_clusters_from_tracked_queries_request)
709
+
710
+ Remove many tracked queries from clusters
711
+
712
+ Minimum role: manager. Removes every tracked query named in \"ids\" from every cluster named in \"queryClusterIds\". At most 100 distinct tracked queries per call; duplicates in \"ids\" are collapsed. Partial success: the answer is 200 with a per-item \"successful\" and \"failed\" list even when some items failed, nothing is rolled back, and an id that is not a tracked query of this project is reported as a failed item rather than dropped. Neither the clusters nor the tracked queries are deleted: only the membership between them. Every cluster must belong to the project in the path; one that does not is rejected with its field named and nothing is written at all. NOTE: this DELETE requires a request body — some HTTP client libraries and proxies strip bodies from DELETE, and a stripped body is refused with a validation error rather than interpreted as \"remove everything\". The \"Idempotency-Key\" header is required, and a repeat of the same key and body returns the recorded answer without running the batch again.
713
+
714
+ ### Examples
715
+
716
+ ```ruby
717
+ require 'time'
718
+ require 'mencoro'
719
+ # setup authorization
720
+ Mencoro.configure do |config|
721
+ # Configure Bearer authorization: ApiKey
722
+ config.access_token = 'YOUR_BEARER_TOKEN'
723
+ end
724
+
725
+ api_instance = Mencoro::TrackedQueriesApi.new
726
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
727
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
728
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation, so a lost response can be retried without repeating the batch.
729
+ bulk_remove_clusters_from_tracked_queries_request = Mencoro::BulkRemoveClustersFromTrackedQueriesRequest.new # BulkRemoveClustersFromTrackedQueriesRequest | Required. A DELETE with no body is rejected.
730
+
731
+ begin
732
+ # Remove many tracked queries from clusters
733
+ result = api_instance.bulk_remove_clusters_from_tracked_queries(organization_id, project_id, idempotency_key, bulk_remove_clusters_from_tracked_queries_request)
734
+ p result
735
+ rescue Mencoro::ApiError => e
736
+ puts "Error when calling TrackedQueriesApi->bulk_remove_clusters_from_tracked_queries: #{e}"
737
+ end
738
+ ```
739
+
740
+ #### Using the bulk_remove_clusters_from_tracked_queries_with_http_info variant
741
+
742
+ This returns an Array which contains the response data, status code and headers.
743
+
744
+ > <Array(<BulkRemoveClustersFromTrackedQueries200Response>, Integer, Hash)> bulk_remove_clusters_from_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, bulk_remove_clusters_from_tracked_queries_request)
745
+
746
+ ```ruby
747
+ begin
748
+ # Remove many tracked queries from clusters
749
+ data, status_code, headers = api_instance.bulk_remove_clusters_from_tracked_queries_with_http_info(organization_id, project_id, idempotency_key, bulk_remove_clusters_from_tracked_queries_request)
750
+ p status_code # => 2xx
751
+ p headers # => { ... }
752
+ p data # => <BulkRemoveClustersFromTrackedQueries200Response>
753
+ rescue Mencoro::ApiError => e
754
+ puts "Error when calling TrackedQueriesApi->bulk_remove_clusters_from_tracked_queries_with_http_info: #{e}"
755
+ end
756
+ ```
757
+
758
+ ### Parameters
759
+
760
+ | Name | Type | Description | Notes |
761
+ | ---- | ---- | ----------- | ----- |
762
+ | **organization_id** | **String** | | |
763
+ | **project_id** | **String** | | |
764
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation, so a lost response can be retried without repeating the batch. | |
765
+ | **bulk_remove_clusters_from_tracked_queries_request** | [**BulkRemoveClustersFromTrackedQueriesRequest**](BulkRemoveClustersFromTrackedQueriesRequest.md) | Required. A DELETE with no body is rejected. | |
766
+
767
+ ### Return type
768
+
769
+ [**BulkRemoveClustersFromTrackedQueries200Response**](BulkRemoveClustersFromTrackedQueries200Response.md)
770
+
771
+ ### Authorization
772
+
773
+ [ApiKey](../README.md#ApiKey)
774
+
775
+ ### HTTP request headers
776
+
777
+ - **Content-Type**: application/json
778
+ - **Accept**: application/json
779
+
780
+
781
+ ## change_tracked_query_check_frequency
782
+
783
+ > <TrackedQueryDetailResource> change_tracked_query_check_frequency(organization_id, project_id, tracked_query_id, idempotency_key, change_tracked_query_check_frequency_request_data)
784
+
785
+ Change how often a tracked query is checked
786
+
787
+ Minimum role: manager. Sets how often one tracked query is checked while it is active. The organization must be active and the project must not be archived. Setting the frequency it already has is accepted and changes nothing. This does NOT run a check, does not backfill history, and does not reschedule a check already in flight: the new cadence applies from the next time the query is considered. A paused query keeps the setting but is not checked until it is resumed. A tracked query belonging to another project answers 404, the same answer an unknown id gets. The Idempotency-Key header is required; a retry with the same key and the same body returns this same answer without applying anything again.
788
+
789
+ ### Examples
790
+
791
+ ```ruby
792
+ require 'time'
793
+ require 'mencoro'
794
+ # setup authorization
795
+ Mencoro.configure do |config|
796
+ # Configure Bearer authorization: ApiKey
797
+ config.access_token = 'YOUR_BEARER_TOKEN'
798
+ end
799
+
800
+ api_instance = Mencoro::TrackedQueriesApi.new
801
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
802
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
803
+ tracked_query_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the project in the path.
804
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation. Replaying it returns the first answer instead of applying anything again.
805
+ change_tracked_query_check_frequency_request_data = Mencoro::ChangeTrackedQueryCheckFrequencyRequestData.new({check_frequency: 'daily'}) # ChangeTrackedQueryCheckFrequencyRequestData |
806
+
807
+ begin
808
+ # Change how often a tracked query is checked
809
+ result = api_instance.change_tracked_query_check_frequency(organization_id, project_id, tracked_query_id, idempotency_key, change_tracked_query_check_frequency_request_data)
810
+ p result
811
+ rescue Mencoro::ApiError => e
812
+ puts "Error when calling TrackedQueriesApi->change_tracked_query_check_frequency: #{e}"
813
+ end
814
+ ```
815
+
816
+ #### Using the change_tracked_query_check_frequency_with_http_info variant
817
+
818
+ This returns an Array which contains the response data, status code and headers.
819
+
820
+ > <Array(<TrackedQueryDetailResource>, Integer, Hash)> change_tracked_query_check_frequency_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key, change_tracked_query_check_frequency_request_data)
821
+
822
+ ```ruby
823
+ begin
824
+ # Change how often a tracked query is checked
825
+ data, status_code, headers = api_instance.change_tracked_query_check_frequency_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key, change_tracked_query_check_frequency_request_data)
826
+ p status_code # => 2xx
827
+ p headers # => { ... }
828
+ p data # => <TrackedQueryDetailResource>
829
+ rescue Mencoro::ApiError => e
830
+ puts "Error when calling TrackedQueriesApi->change_tracked_query_check_frequency_with_http_info: #{e}"
831
+ end
832
+ ```
833
+
834
+ ### Parameters
835
+
836
+ | Name | Type | Description | Notes |
837
+ | ---- | ---- | ----------- | ----- |
838
+ | **organization_id** | **String** | | |
839
+ | **project_id** | **String** | | |
840
+ | **tracked_query_id** | **String** | Must belong to the project in the path. | |
841
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation. Replaying it returns the first answer instead of applying anything again. | |
842
+ | **change_tracked_query_check_frequency_request_data** | [**ChangeTrackedQueryCheckFrequencyRequestData**](ChangeTrackedQueryCheckFrequencyRequestData.md) | | |
843
+
844
+ ### Return type
845
+
846
+ [**TrackedQueryDetailResource**](TrackedQueryDetailResource.md)
847
+
848
+ ### Authorization
849
+
850
+ [ApiKey](../README.md#ApiKey)
851
+
852
+ ### HTTP request headers
853
+
854
+ - **Content-Type**: application/json
855
+ - **Accept**: application/json
856
+
857
+
858
+ ## change_tracked_query_n_passes
859
+
860
+ > <TrackedQueryDetailResource> change_tracked_query_n_passes(organization_id, project_id, tracked_query_id, idempotency_key, change_tracked_query_passes_request_data)
861
+
862
+ Change how many passes a tracked query runs per check
863
+
864
+ Minimum role: manager. Sets how many times one tracked query is asked per check. AI engines are not deterministic, so several passes are averaged; `google_serp` and `google_shopping` run a single pass and refuse any value above one with 409 `n_passes_not_supported_for_engine`. Setting the value back to 1 is always allowed. The organization must be active and the project must not be archived. Setting the value it already has is accepted and changes nothing. This does NOT run a check and does not change history already captured: it applies from the next check. More passes cost proportionally more of the plan's check budget. A tracked query belonging to another project answers 404, the same answer an unknown id gets. The Idempotency-Key header is required; a retry with the same key and the same body returns this same answer without applying anything again.
865
+
866
+ ### Examples
867
+
868
+ ```ruby
869
+ require 'time'
870
+ require 'mencoro'
871
+ # setup authorization
872
+ Mencoro.configure do |config|
873
+ # Configure Bearer authorization: ApiKey
874
+ config.access_token = 'YOUR_BEARER_TOKEN'
875
+ end
876
+
877
+ api_instance = Mencoro::TrackedQueriesApi.new
878
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
879
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
880
+ tracked_query_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the project in the path.
881
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation. Replaying it returns the first answer instead of applying anything again.
882
+ change_tracked_query_passes_request_data = Mencoro::ChangeTrackedQueryPassesRequestData.new({n_passes: 37}) # ChangeTrackedQueryPassesRequestData |
883
+
884
+ begin
885
+ # Change how many passes a tracked query runs per check
886
+ result = api_instance.change_tracked_query_n_passes(organization_id, project_id, tracked_query_id, idempotency_key, change_tracked_query_passes_request_data)
887
+ p result
888
+ rescue Mencoro::ApiError => e
889
+ puts "Error when calling TrackedQueriesApi->change_tracked_query_n_passes: #{e}"
890
+ end
891
+ ```
892
+
893
+ #### Using the change_tracked_query_n_passes_with_http_info variant
894
+
895
+ This returns an Array which contains the response data, status code and headers.
896
+
897
+ > <Array(<TrackedQueryDetailResource>, Integer, Hash)> change_tracked_query_n_passes_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key, change_tracked_query_passes_request_data)
898
+
899
+ ```ruby
900
+ begin
901
+ # Change how many passes a tracked query runs per check
902
+ data, status_code, headers = api_instance.change_tracked_query_n_passes_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key, change_tracked_query_passes_request_data)
903
+ p status_code # => 2xx
904
+ p headers # => { ... }
905
+ p data # => <TrackedQueryDetailResource>
906
+ rescue Mencoro::ApiError => e
907
+ puts "Error when calling TrackedQueriesApi->change_tracked_query_n_passes_with_http_info: #{e}"
908
+ end
909
+ ```
910
+
911
+ ### Parameters
912
+
913
+ | Name | Type | Description | Notes |
914
+ | ---- | ---- | ----------- | ----- |
915
+ | **organization_id** | **String** | | |
916
+ | **project_id** | **String** | | |
917
+ | **tracked_query_id** | **String** | Must belong to the project in the path. | |
918
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation. Replaying it returns the first answer instead of applying anything again. | |
919
+ | **change_tracked_query_passes_request_data** | [**ChangeTrackedQueryPassesRequestData**](ChangeTrackedQueryPassesRequestData.md) | | |
920
+
921
+ ### Return type
922
+
923
+ [**TrackedQueryDetailResource**](TrackedQueryDetailResource.md)
924
+
925
+ ### Authorization
926
+
927
+ [ApiKey](../README.md#ApiKey)
928
+
929
+ ### HTTP request headers
930
+
931
+ - **Content-Type**: application/json
932
+ - **Accept**: application/json
933
+
934
+
935
+ ## count_tracked_queries
936
+
937
+ > <TrackedQueryCountResource> count_tracked_queries(organization_id, project_id, opts)
938
+
939
+ Count a project's tracked queries and price checking them
940
+
941
+ Minimum role: viewer. Two numbers about one project: how many tracked queries it holds, and what force-checking that same set would cost. Omit `status` to count every tracked query whatever its status; send `active` or `paused` to count and price only those. `checkCost` is a PRICED DRY RUN expressed in check budget units — one unit per pass, the same unit the plan allowance is counted in, so it is directly comparable with `checksAvailable` from the entitlements operation — and it is the sum of each matched tracked query's configured passes. Asking reserves nothing, debits nothing and starts no check. It is deliberately NOT a forecast of what the check-all operation will consume: that operation skips paused queries, skips a query whose check is already pending or running, re-runs a check awaiting retry without charging for it again, and stops at whatever budget is left — none of which is subtracted here. Count with `status=active` for the figure closest to a full check-all. Both numbers are read from the write model, so a tracked query created moments ago is already in them; that is why they can be AHEAD of the `total` returned by the tracked-queries listing, which counts a search projection, and ahead of the keyword listings, which read projections refreshed in the background. Summing the unfiltered count over every project of an organization, archived projects included, reproduces countOrganizationTrackedQueries, which counts through the same counter in the same store. An archived project still answers, because this is a read, but no check can be submitted there while it stays archived, so its cost is hypothetical. For a month of scheduled rounds across the whole organization instead of one round over one project, read getOrganizationProjectedMonthlyChecks. No monetary amount is published or implied: the cost of a check is published only in budget units.
942
+
943
+ ### Examples
944
+
945
+ ```ruby
946
+ require 'time'
947
+ require 'mencoro'
948
+ # setup authorization
949
+ Mencoro.configure do |config|
950
+ # Configure Bearer authorization: ApiKey
951
+ config.access_token = 'YOUR_BEARER_TOKEN'
952
+ end
953
+
954
+ api_instance = Mencoro::TrackedQueriesApi.new
955
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
956
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
957
+ opts = {
958
+ status: 'active' # String | Restrict both numbers to one status. Lower-case; an unknown value is rejected, not ignored. Omitted, every status is counted and priced.
959
+ }
960
+
961
+ begin
962
+ # Count a project's tracked queries and price checking them
963
+ result = api_instance.count_tracked_queries(organization_id, project_id, opts)
964
+ p result
965
+ rescue Mencoro::ApiError => e
966
+ puts "Error when calling TrackedQueriesApi->count_tracked_queries: #{e}"
967
+ end
968
+ ```
969
+
970
+ #### Using the count_tracked_queries_with_http_info variant
971
+
972
+ This returns an Array which contains the response data, status code and headers.
973
+
974
+ > <Array(<TrackedQueryCountResource>, Integer, Hash)> count_tracked_queries_with_http_info(organization_id, project_id, opts)
975
+
976
+ ```ruby
977
+ begin
978
+ # Count a project's tracked queries and price checking them
979
+ data, status_code, headers = api_instance.count_tracked_queries_with_http_info(organization_id, project_id, opts)
980
+ p status_code # => 2xx
981
+ p headers # => { ... }
982
+ p data # => <TrackedQueryCountResource>
983
+ rescue Mencoro::ApiError => e
984
+ puts "Error when calling TrackedQueriesApi->count_tracked_queries_with_http_info: #{e}"
985
+ end
986
+ ```
987
+
988
+ ### Parameters
989
+
990
+ | Name | Type | Description | Notes |
991
+ | ---- | ---- | ----------- | ----- |
992
+ | **organization_id** | **String** | | |
993
+ | **project_id** | **String** | | |
994
+ | **status** | **String** | Restrict both numbers to one status. Lower-case; an unknown value is rejected, not ignored. Omitted, every status is counted and priced. | [optional] |
995
+
996
+ ### Return type
997
+
998
+ [**TrackedQueryCountResource**](TrackedQueryCountResource.md)
999
+
1000
+ ### Authorization
1001
+
1002
+ [ApiKey](../README.md#ApiKey)
1003
+
1004
+ ### HTTP request headers
1005
+
1006
+ - **Content-Type**: Not defined
1007
+ - **Accept**: application/json
1008
+
1009
+
1010
+ ## force_check_all_active_tracked_queries
1011
+
1012
+ > <SubmittedChecksResource> force_check_all_active_tracked_queries(organization_id, project_id, idempotency_key)
1013
+
1014
+ Check every eligible tracked query of a project now
1015
+
1016
+ Minimum role: manager. Submits a fresh check for every eligible tracked query of the project, ignoring how recently each was last checked, least-recently-checked first, and at most 1000 tracked queries per call. Eligible is narrower than active: a paused query is skipped, and so is one whose check is already pending or running for the same engine. A query whose check is awaiting a retry is included and, WHEN THE ENGINE HAS NOT CHANGED SINCE, costs nothing extra, because its first submission already paid for it; if the engine did change, the pending run is replaced and the replacement is paid for. What is left is trimmed to what the organization's remaining check budget can pay for — a check costs one budget unit per pass. While a subscription is cancelled but still inside its paid grace window nothing is submitted at all and `submitted` is 0; name the queries explicitly through the check operation to run them in that window. CALLING AGAIN DOES NOT CONTINUE WHERE THIS CALL STOPPED: submissions are handed to a worker, and a tracked query stops being selected only once that worker has started its check, so a second call made before the queue drains selects and submits the same tracked queries again. That is safe while the first check is still running — the duplicate is collapsed, and nothing is checked or charged twice — but a check that has already finished is run again and charged again, because this operation ignores staleness by design. To cover a project with more than 1000 eligible tracked queries, wait for the submitted wave to be picked up — each tracked query's lastCheckedAt advances when its check completes — and call again then. The response lists the tracked queries submitted and carries NO job id: a check already in flight is reused rather than started again, so no id could be guaranteed to exist. Submission is accepted, not completed: a listed tracked query can still lose the last budget units to another caller before the worker reaches it. The request takes no body, and any field sent is rejected. Requires an Idempotency-Key header.
1017
+
1018
+ ### Examples
1019
+
1020
+ ```ruby
1021
+ require 'time'
1022
+ require 'mencoro'
1023
+ # setup authorization
1024
+ Mencoro.configure do |config|
1025
+ # Configure Bearer authorization: ApiKey
1026
+ config.access_token = 'YOUR_BEARER_TOKEN'
1027
+ end
1028
+
1029
+ api_instance = Mencoro::TrackedQueriesApi.new
1030
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1031
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1032
+ idempotency_key = 'idempotency_key_example' # String | Repeating a request with the same key answers with the first attempt's result instead of submitting a second wave.
1033
+
1034
+ begin
1035
+ # Check every eligible tracked query of a project now
1036
+ result = api_instance.force_check_all_active_tracked_queries(organization_id, project_id, idempotency_key)
1037
+ p result
1038
+ rescue Mencoro::ApiError => e
1039
+ puts "Error when calling TrackedQueriesApi->force_check_all_active_tracked_queries: #{e}"
1040
+ end
1041
+ ```
1042
+
1043
+ #### Using the force_check_all_active_tracked_queries_with_http_info variant
1044
+
1045
+ This returns an Array which contains the response data, status code and headers.
1046
+
1047
+ > <Array(<SubmittedChecksResource>, Integer, Hash)> force_check_all_active_tracked_queries_with_http_info(organization_id, project_id, idempotency_key)
1048
+
1049
+ ```ruby
1050
+ begin
1051
+ # Check every eligible tracked query of a project now
1052
+ data, status_code, headers = api_instance.force_check_all_active_tracked_queries_with_http_info(organization_id, project_id, idempotency_key)
1053
+ p status_code # => 2xx
1054
+ p headers # => { ... }
1055
+ p data # => <SubmittedChecksResource>
1056
+ rescue Mencoro::ApiError => e
1057
+ puts "Error when calling TrackedQueriesApi->force_check_all_active_tracked_queries_with_http_info: #{e}"
1058
+ end
1059
+ ```
1060
+
1061
+ ### Parameters
1062
+
1063
+ | Name | Type | Description | Notes |
1064
+ | ---- | ---- | ----------- | ----- |
1065
+ | **organization_id** | **String** | | |
1066
+ | **project_id** | **String** | | |
1067
+ | **idempotency_key** | **String** | Repeating a request with the same key answers with the first attempt&#39;s result instead of submitting a second wave. | |
1068
+
1069
+ ### Return type
1070
+
1071
+ [**SubmittedChecksResource**](SubmittedChecksResource.md)
1072
+
1073
+ ### Authorization
1074
+
1075
+ [ApiKey](../README.md#ApiKey)
1076
+
1077
+ ### HTTP request headers
1078
+
1079
+ - **Content-Type**: Not defined
1080
+ - **Accept**: application/json
1081
+
1082
+
1083
+ ## get_tracked_query
1084
+
1085
+ > <TrackedQueryDetailResource> get_tracked_query(organization_id, project_id, tracked_query_id)
1086
+
1087
+ Get a tracked query
1088
+
1089
+ Minimum role: viewer. The configuration of one tracked query: the text sent to the engine, the engine, locale and country it is asked in, the clusters it belongs to, and how often it is checked. A lastCheckedAt of null means no check has completed yet — it is not a check that found nothing. A tracked query belonging to another project answers 404, the same answer an unknown id gets, so the API never confirms that an inaccessible tracked query exists. Rank positions, share of voice and sentiment are not part of this response: they belong to a date window and are served by the analytics endpoints.
1090
+
1091
+ ### Examples
1092
+
1093
+ ```ruby
1094
+ require 'time'
1095
+ require 'mencoro'
1096
+ # setup authorization
1097
+ Mencoro.configure do |config|
1098
+ # Configure Bearer authorization: ApiKey
1099
+ config.access_token = 'YOUR_BEARER_TOKEN'
1100
+ end
1101
+
1102
+ api_instance = Mencoro::TrackedQueriesApi.new
1103
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1104
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1105
+ tracked_query_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the project in the path.
1106
+
1107
+ begin
1108
+ # Get a tracked query
1109
+ result = api_instance.get_tracked_query(organization_id, project_id, tracked_query_id)
1110
+ p result
1111
+ rescue Mencoro::ApiError => e
1112
+ puts "Error when calling TrackedQueriesApi->get_tracked_query: #{e}"
1113
+ end
1114
+ ```
1115
+
1116
+ #### Using the get_tracked_query_with_http_info variant
1117
+
1118
+ This returns an Array which contains the response data, status code and headers.
1119
+
1120
+ > <Array(<TrackedQueryDetailResource>, Integer, Hash)> get_tracked_query_with_http_info(organization_id, project_id, tracked_query_id)
1121
+
1122
+ ```ruby
1123
+ begin
1124
+ # Get a tracked query
1125
+ data, status_code, headers = api_instance.get_tracked_query_with_http_info(organization_id, project_id, tracked_query_id)
1126
+ p status_code # => 2xx
1127
+ p headers # => { ... }
1128
+ p data # => <TrackedQueryDetailResource>
1129
+ rescue Mencoro::ApiError => e
1130
+ puts "Error when calling TrackedQueriesApi->get_tracked_query_with_http_info: #{e}"
1131
+ end
1132
+ ```
1133
+
1134
+ ### Parameters
1135
+
1136
+ | Name | Type | Description | Notes |
1137
+ | ---- | ---- | ----------- | ----- |
1138
+ | **organization_id** | **String** | | |
1139
+ | **project_id** | **String** | | |
1140
+ | **tracked_query_id** | **String** | Must belong to the project in the path. | |
1141
+
1142
+ ### Return type
1143
+
1144
+ [**TrackedQueryDetailResource**](TrackedQueryDetailResource.md)
1145
+
1146
+ ### Authorization
1147
+
1148
+ [ApiKey](../README.md#ApiKey)
1149
+
1150
+ ### HTTP request headers
1151
+
1152
+ - **Content-Type**: Not defined
1153
+ - **Accept**: application/json
1154
+
1155
+
1156
+ ## pause_tracked_query
1157
+
1158
+ > <TrackedQueryDetailResource> pause_tracked_query(organization_id, project_id, tracked_query_id, idempotency_key)
1159
+
1160
+ Pause a tracked query
1161
+
1162
+ Minimum role: manager. Stops the scheduler from checking this tracked query; it keeps its configuration, its clusters and every result already collected, and nothing is deleted. Pausing a query that is already paused succeeds and answers the same body — this is a PUT asserting a state, not a transition, so it is safe to repeat. It does NOT cancel a check that is already running: a check in flight when the pause lands still completes and still consumes the budget unit it reserved. The request takes no body, and any field sent is rejected. Requires an Idempotency-Key header.
1163
+
1164
+ ### Examples
1165
+
1166
+ ```ruby
1167
+ require 'time'
1168
+ require 'mencoro'
1169
+ # setup authorization
1170
+ Mencoro.configure do |config|
1171
+ # Configure Bearer authorization: ApiKey
1172
+ config.access_token = 'YOUR_BEARER_TOKEN'
1173
+ end
1174
+
1175
+ api_instance = Mencoro::TrackedQueriesApi.new
1176
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1177
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1178
+ tracked_query_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the project in the path.
1179
+ idempotency_key = 'idempotency_key_example' # String | Repeating a request with the same key answers with the first attempt's result instead of pausing again.
1180
+
1181
+ begin
1182
+ # Pause a tracked query
1183
+ result = api_instance.pause_tracked_query(organization_id, project_id, tracked_query_id, idempotency_key)
1184
+ p result
1185
+ rescue Mencoro::ApiError => e
1186
+ puts "Error when calling TrackedQueriesApi->pause_tracked_query: #{e}"
1187
+ end
1188
+ ```
1189
+
1190
+ #### Using the pause_tracked_query_with_http_info variant
1191
+
1192
+ This returns an Array which contains the response data, status code and headers.
1193
+
1194
+ > <Array(<TrackedQueryDetailResource>, Integer, Hash)> pause_tracked_query_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key)
1195
+
1196
+ ```ruby
1197
+ begin
1198
+ # Pause a tracked query
1199
+ data, status_code, headers = api_instance.pause_tracked_query_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key)
1200
+ p status_code # => 2xx
1201
+ p headers # => { ... }
1202
+ p data # => <TrackedQueryDetailResource>
1203
+ rescue Mencoro::ApiError => e
1204
+ puts "Error when calling TrackedQueriesApi->pause_tracked_query_with_http_info: #{e}"
1205
+ end
1206
+ ```
1207
+
1208
+ ### Parameters
1209
+
1210
+ | Name | Type | Description | Notes |
1211
+ | ---- | ---- | ----------- | ----- |
1212
+ | **organization_id** | **String** | | |
1213
+ | **project_id** | **String** | | |
1214
+ | **tracked_query_id** | **String** | Must belong to the project in the path. | |
1215
+ | **idempotency_key** | **String** | Repeating a request with the same key answers with the first attempt&#39;s result instead of pausing again. | |
1216
+
1217
+ ### Return type
1218
+
1219
+ [**TrackedQueryDetailResource**](TrackedQueryDetailResource.md)
1220
+
1221
+ ### Authorization
1222
+
1223
+ [ApiKey](../README.md#ApiKey)
1224
+
1225
+ ### HTTP request headers
1226
+
1227
+ - **Content-Type**: Not defined
1228
+ - **Accept**: application/json
1229
+
1230
+
1231
+ ## remove_clusters_from_tracked_query
1232
+
1233
+ > <TrackedQueryDetailResource> remove_clusters_from_tracked_query(organization_id, project_id, tracked_query_id, idempotency_key, cluster_membership_request_data)
1234
+
1235
+ Remove a tracked query from clusters
1236
+
1237
+ Minimum role: manager. Removes the tracked query from every cluster named in \"queryClusterIds\" and answers with the query in its new state. A cluster the query does not belong to is skipped, not reported as an error. Neither the clusters nor the tracked query are deleted: only the membership between them. Every cluster must belong to the project in the path. NOTE: this DELETE requires a request body — some HTTP client libraries and proxies strip bodies from DELETE, and a stripped body is refused with a validation error rather than interpreted as \"remove all clusters\". The \"Idempotency-Key\" header is required, and a repeat of the same key and body returns the recorded answer without removing anything again.
1238
+
1239
+ ### Examples
1240
+
1241
+ ```ruby
1242
+ require 'time'
1243
+ require 'mencoro'
1244
+ # setup authorization
1245
+ Mencoro.configure do |config|
1246
+ # Configure Bearer authorization: ApiKey
1247
+ config.access_token = 'YOUR_BEARER_TOKEN'
1248
+ end
1249
+
1250
+ api_instance = Mencoro::TrackedQueriesApi.new
1251
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1252
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1253
+ tracked_query_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the project in the path.
1254
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per operation, so a lost response can be retried without repeating the write.
1255
+ cluster_membership_request_data = Mencoro::ClusterMembershipRequestData.new({query_cluster_ids: ['query_cluster_ids_example']}) # ClusterMembershipRequestData | Required. A DELETE with no body is rejected.
1256
+
1257
+ begin
1258
+ # Remove a tracked query from clusters
1259
+ result = api_instance.remove_clusters_from_tracked_query(organization_id, project_id, tracked_query_id, idempotency_key, cluster_membership_request_data)
1260
+ p result
1261
+ rescue Mencoro::ApiError => e
1262
+ puts "Error when calling TrackedQueriesApi->remove_clusters_from_tracked_query: #{e}"
1263
+ end
1264
+ ```
1265
+
1266
+ #### Using the remove_clusters_from_tracked_query_with_http_info variant
1267
+
1268
+ This returns an Array which contains the response data, status code and headers.
1269
+
1270
+ > <Array(<TrackedQueryDetailResource>, Integer, Hash)> remove_clusters_from_tracked_query_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key, cluster_membership_request_data)
1271
+
1272
+ ```ruby
1273
+ begin
1274
+ # Remove a tracked query from clusters
1275
+ data, status_code, headers = api_instance.remove_clusters_from_tracked_query_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key, cluster_membership_request_data)
1276
+ p status_code # => 2xx
1277
+ p headers # => { ... }
1278
+ p data # => <TrackedQueryDetailResource>
1279
+ rescue Mencoro::ApiError => e
1280
+ puts "Error when calling TrackedQueriesApi->remove_clusters_from_tracked_query_with_http_info: #{e}"
1281
+ end
1282
+ ```
1283
+
1284
+ ### Parameters
1285
+
1286
+ | Name | Type | Description | Notes |
1287
+ | ---- | ---- | ----------- | ----- |
1288
+ | **organization_id** | **String** | | |
1289
+ | **project_id** | **String** | | |
1290
+ | **tracked_query_id** | **String** | Must belong to the project in the path. | |
1291
+ | **idempotency_key** | **String** | A client-chosen key, unique per operation, so a lost response can be retried without repeating the write. | |
1292
+ | **cluster_membership_request_data** | [**ClusterMembershipRequestData**](ClusterMembershipRequestData.md) | Required. A DELETE with no body is rejected. | |
1293
+
1294
+ ### Return type
1295
+
1296
+ [**TrackedQueryDetailResource**](TrackedQueryDetailResource.md)
1297
+
1298
+ ### Authorization
1299
+
1300
+ [ApiKey](../README.md#ApiKey)
1301
+
1302
+ ### HTTP request headers
1303
+
1304
+ - **Content-Type**: application/json
1305
+ - **Accept**: application/json
1306
+
1307
+
1308
+ ## report_ai_response
1309
+
1310
+ > <AiResponseReportResource> report_ai_response(organization_id, project_id, tracked_query_id, ai_response_id, idempotency_key, report_ai_response_request)
1311
+
1312
+ Report a problem with a captured AI answer
1313
+
1314
+ Minimum role: viewer — deliberately lower than the other tracked-query writes, because a report changes nothing a viewer cannot already read. The key still needs the \"write\" capability. The report is forwarded to the team that reviews the scrape run behind the capture; it does not change the capture, the tracked query, or any metric derived from them, and nothing in this API will show the report afterwards. A 200 means the report was accepted for review, not that anything was corrected, and there is no identifier to poll. A capture that belongs to another tracked query or project answers 404, the same answer an unknown id gets. A capture that cannot be routed back to its scrape run answers 409 \"ai_check_session_unavailable\", and it cannot be reported. That code covers two moments, which behave differently for your key: when the capture carries no scrape run at all the refusal is decided BEFORE anything is sent, so the idempotency key is left unused and the same key answers the same way however often it is presented; when the review system itself rejects the run — its own retention having elapsed — the refusal comes after the forward was attempted, so the key is spent like any outcome we cannot confirm. You can tell them apart without guessing: retry the same key, and a reply of \"operation_outcome_uncertain\" means the refusal came from the review system. Delivery is at-most-once: the \"Idempotency-Key\" header is required and a repeat of the same key and body returns the recorded answer, but a delivery whose outcome is unknown refuses replay on that key rather than risk filing the report twice.
1315
+
1316
+ ### Examples
1317
+
1318
+ ```ruby
1319
+ require 'time'
1320
+ require 'mencoro'
1321
+ # setup authorization
1322
+ Mencoro.configure do |config|
1323
+ # Configure Bearer authorization: ApiKey
1324
+ config.access_token = 'YOUR_BEARER_TOKEN'
1325
+ end
1326
+
1327
+ api_instance = Mencoro::TrackedQueriesApi.new
1328
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1329
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1330
+ tracked_query_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the project in the path.
1331
+ ai_response_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | A capture id from the AI responses listing. Must belong to the tracked query in the path.
1332
+ idempotency_key = 'idempotency_key_example' # String | A client-chosen key, unique per report, so a lost response can be retried without filing the report twice.
1333
+ report_ai_response_request = Mencoro::ReportAiResponseRequest.new({type: 'missed_mention'}) # ReportAiResponseRequest |
1334
+
1335
+ begin
1336
+ # Report a problem with a captured AI answer
1337
+ result = api_instance.report_ai_response(organization_id, project_id, tracked_query_id, ai_response_id, idempotency_key, report_ai_response_request)
1338
+ p result
1339
+ rescue Mencoro::ApiError => e
1340
+ puts "Error when calling TrackedQueriesApi->report_ai_response: #{e}"
1341
+ end
1342
+ ```
1343
+
1344
+ #### Using the report_ai_response_with_http_info variant
1345
+
1346
+ This returns an Array which contains the response data, status code and headers.
1347
+
1348
+ > <Array(<AiResponseReportResource>, Integer, Hash)> report_ai_response_with_http_info(organization_id, project_id, tracked_query_id, ai_response_id, idempotency_key, report_ai_response_request)
1349
+
1350
+ ```ruby
1351
+ begin
1352
+ # Report a problem with a captured AI answer
1353
+ data, status_code, headers = api_instance.report_ai_response_with_http_info(organization_id, project_id, tracked_query_id, ai_response_id, idempotency_key, report_ai_response_request)
1354
+ p status_code # => 2xx
1355
+ p headers # => { ... }
1356
+ p data # => <AiResponseReportResource>
1357
+ rescue Mencoro::ApiError => e
1358
+ puts "Error when calling TrackedQueriesApi->report_ai_response_with_http_info: #{e}"
1359
+ end
1360
+ ```
1361
+
1362
+ ### Parameters
1363
+
1364
+ | Name | Type | Description | Notes |
1365
+ | ---- | ---- | ----------- | ----- |
1366
+ | **organization_id** | **String** | | |
1367
+ | **project_id** | **String** | | |
1368
+ | **tracked_query_id** | **String** | Must belong to the project in the path. | |
1369
+ | **ai_response_id** | **String** | A capture id from the AI responses listing. Must belong to the tracked query in the path. | |
1370
+ | **idempotency_key** | **String** | A client-chosen key, unique per report, so a lost response can be retried without filing the report twice. | |
1371
+ | **report_ai_response_request** | [**ReportAiResponseRequest**](ReportAiResponseRequest.md) | | |
1372
+
1373
+ ### Return type
1374
+
1375
+ [**AiResponseReportResource**](AiResponseReportResource.md)
1376
+
1377
+ ### Authorization
1378
+
1379
+ [ApiKey](../README.md#ApiKey)
1380
+
1381
+ ### HTTP request headers
1382
+
1383
+ - **Content-Type**: application/json
1384
+ - **Accept**: application/json
1385
+
1386
+
1387
+ ## resume_tracked_query
1388
+
1389
+ > <TrackedQueryDetailResource> resume_tracked_query(organization_id, project_id, tracked_query_id, idempotency_key)
1390
+
1391
+ Resume a tracked query
1392
+
1393
+ Minimum role: manager. Puts a paused tracked query back under the scheduler. Resuming a query that is already active succeeds and answers the same body — this is a PUT asserting a state, not a transition. It does NOT run a check: the query is checked when it next falls due under its own checkFrequency, and results collected while it was paused are unaffected. Nothing is back-filled for the time it spent paused. The request takes no body, and any field sent is rejected. Requires an Idempotency-Key header.
1394
+
1395
+ ### Examples
1396
+
1397
+ ```ruby
1398
+ require 'time'
1399
+ require 'mencoro'
1400
+ # setup authorization
1401
+ Mencoro.configure do |config|
1402
+ # Configure Bearer authorization: ApiKey
1403
+ config.access_token = 'YOUR_BEARER_TOKEN'
1404
+ end
1405
+
1406
+ api_instance = Mencoro::TrackedQueriesApi.new
1407
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1408
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1409
+ tracked_query_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the project in the path.
1410
+ idempotency_key = 'idempotency_key_example' # String | Repeating a request with the same key answers with the first attempt's result instead of resuming again.
1411
+
1412
+ begin
1413
+ # Resume a tracked query
1414
+ result = api_instance.resume_tracked_query(organization_id, project_id, tracked_query_id, idempotency_key)
1415
+ p result
1416
+ rescue Mencoro::ApiError => e
1417
+ puts "Error when calling TrackedQueriesApi->resume_tracked_query: #{e}"
1418
+ end
1419
+ ```
1420
+
1421
+ #### Using the resume_tracked_query_with_http_info variant
1422
+
1423
+ This returns an Array which contains the response data, status code and headers.
1424
+
1425
+ > <Array(<TrackedQueryDetailResource>, Integer, Hash)> resume_tracked_query_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key)
1426
+
1427
+ ```ruby
1428
+ begin
1429
+ # Resume a tracked query
1430
+ data, status_code, headers = api_instance.resume_tracked_query_with_http_info(organization_id, project_id, tracked_query_id, idempotency_key)
1431
+ p status_code # => 2xx
1432
+ p headers # => { ... }
1433
+ p data # => <TrackedQueryDetailResource>
1434
+ rescue Mencoro::ApiError => e
1435
+ puts "Error when calling TrackedQueriesApi->resume_tracked_query_with_http_info: #{e}"
1436
+ end
1437
+ ```
1438
+
1439
+ ### Parameters
1440
+
1441
+ | Name | Type | Description | Notes |
1442
+ | ---- | ---- | ----------- | ----- |
1443
+ | **organization_id** | **String** | | |
1444
+ | **project_id** | **String** | | |
1445
+ | **tracked_query_id** | **String** | Must belong to the project in the path. | |
1446
+ | **idempotency_key** | **String** | Repeating a request with the same key answers with the first attempt&#39;s result instead of resuming again. | |
1447
+
1448
+ ### Return type
1449
+
1450
+ [**TrackedQueryDetailResource**](TrackedQueryDetailResource.md)
1451
+
1452
+ ### Authorization
1453
+
1454
+ [ApiKey](../README.md#ApiKey)
1455
+
1456
+ ### HTTP request headers
1457
+
1458
+ - **Content-Type**: Not defined
1459
+ - **Accept**: application/json
1460
+
1461
+
1462
+ ## search_tracked_queries
1463
+
1464
+ > <SearchTrackedQueries200Response> search_tracked_queries(organization_id, project_id, opts)
1465
+
1466
+ Search a project's tracked queries
1467
+
1468
+ Minimum role: viewer. One row per tracked query — a single keyword on a single engine in a single country — carrying the metrics of its most recent completed check. Filter by status, engine, country and a free-text search over the keyword, and sort by any of the returned metrics. Positions (lastSerpPosition, lastMentionPosition, lastLinkPosition, lastShoppingPosition) are 1-based ranks, so LOWER is better; lastShareOfVoice and lastPositivityIndex are percentages from 0 to 100, where HIGHER is better. Every nullable field means \"not known yet\" rather than zero: a null position is a query with no data for that surface, a null lastPositivityIndex is a check with no mentions to score, and a null lastCheckedAt is a query that has never been checked — none of them is a score of zero. This listing reads a projection refreshed by background subscribers, not the write model, so a tracked query created or changed moments ago may not appear here yet or may still show its previous settings. It catches up on its own; nothing is lost. If you need to read back what you just wrote, the creation response carries the new ids and the single tracked-query operation reads the write model directly. total counts the tracked queries the filters match, not the rows on this page. A limit above the maximum is rejected, never clamped, and a filter this endpoint does not support is rejected rather than ignored.Send `Accept: text/csv` to receive the same page as a CSV download instead of JSON: same filters, same authorization, same page window and the same maximum of 100 rows — it is this page in another format, not a bulk export, so a whole collection is still read by paging. The CSV carries no `total`, because a table whose every row is a record has nowhere to put one; read it from the JSON representation of the same request. A list-valued field is joined into one cell with `; ` as a display projection — parse the JSON if you need the structure. Cells beginning with `=`, `+`, `-` or `@` are prefixed with an apostrophe so a spreadsheet treats them as text rather than running them as formulas.
1469
+
1470
+ ### Examples
1471
+
1472
+ ```ruby
1473
+ require 'time'
1474
+ require 'mencoro'
1475
+ # setup authorization
1476
+ Mencoro.configure do |config|
1477
+ # Configure Bearer authorization: ApiKey
1478
+ config.access_token = 'YOUR_BEARER_TOKEN'
1479
+ end
1480
+
1481
+ api_instance = Mencoro::TrackedQueriesApi.new
1482
+ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1483
+ project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
1484
+ opts = {
1485
+ limit: 56, # Integer | Page size. A value above the maximum is rejected, never clamped.
1486
+ offset: 56, # Integer |
1487
+ search: 'search_example', # String | Free-text search over the keyword.
1488
+ status: 'active', # String |
1489
+ engines: ['chatgpt'], # Array<String> | Repeatable, or comma-separated.
1490
+ countries: ['inner_example'], # Array<String> | ISO-3166 alpha-2 codes or English names. Must be configured on the project.
1491
+ sort_by: 'queryText', # String |
1492
+ sort_order: 'asc' # String |
1493
+ }
1494
+
1495
+ begin
1496
+ # Search a project's tracked queries
1497
+ result = api_instance.search_tracked_queries(organization_id, project_id, opts)
1498
+ p result
1499
+ rescue Mencoro::ApiError => e
1500
+ puts "Error when calling TrackedQueriesApi->search_tracked_queries: #{e}"
1501
+ end
1502
+ ```
1503
+
1504
+ #### Using the search_tracked_queries_with_http_info variant
1505
+
1506
+ This returns an Array which contains the response data, status code and headers.
1507
+
1508
+ > <Array(<SearchTrackedQueries200Response>, Integer, Hash)> search_tracked_queries_with_http_info(organization_id, project_id, opts)
1509
+
1510
+ ```ruby
1511
+ begin
1512
+ # Search a project's tracked queries
1513
+ data, status_code, headers = api_instance.search_tracked_queries_with_http_info(organization_id, project_id, opts)
1514
+ p status_code # => 2xx
1515
+ p headers # => { ... }
1516
+ p data # => <SearchTrackedQueries200Response>
1517
+ rescue Mencoro::ApiError => e
1518
+ puts "Error when calling TrackedQueriesApi->search_tracked_queries_with_http_info: #{e}"
1519
+ end
1520
+ ```
1521
+
1522
+ ### Parameters
1523
+
1524
+ | Name | Type | Description | Notes |
1525
+ | ---- | ---- | ----------- | ----- |
1526
+ | **organization_id** | **String** | | |
1527
+ | **project_id** | **String** | | |
1528
+ | **limit** | **Integer** | Page size. A value above the maximum is rejected, never clamped. | [optional][default to 20] |
1529
+ | **offset** | **Integer** | | [optional][default to 0] |
1530
+ | **search** | **String** | Free-text search over the keyword. | [optional] |
1531
+ | **status** | **String** | | [optional] |
1532
+ | **engines** | [**Array&lt;String&gt;**](String.md) | Repeatable, or comma-separated. | [optional] |
1533
+ | **countries** | [**Array&lt;String&gt;**](String.md) | ISO-3166 alpha-2 codes or English names. Must be configured on the project. | [optional] |
1534
+ | **sort_by** | **String** | | [optional][default to &#39;queryText&#39;] |
1535
+ | **sort_order** | **String** | | [optional][default to &#39;desc&#39;] |
1536
+
1537
+ ### Return type
1538
+
1539
+ [**SearchTrackedQueries200Response**](SearchTrackedQueries200Response.md)
1540
+
1541
+ ### Authorization
1542
+
1543
+ [ApiKey](../README.md#ApiKey)
1544
+
1545
+ ### HTTP request headers
1546
+
1547
+ - **Content-Type**: Not defined
1548
+ - **Accept**: application/json, text/csv
1549
+