mencoro 1.0.0

data/docs/GetOrganizationOverview200ResponseAggregate.md

@@ -0,0 +1,30 @@
+# Mencoro::GetOrganizationOverview200ResponseAggregate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_count** | **Integer** | Active projects in the organization, the length of `projects`. | [optional] |
+| **projects_with_data** | **Integer** | How many of those have a share of voice; the averages below are means over the projects that report each metric, never over the ones still null. | [optional] |
+| **total_tracked_queries** | **Integer** |  | [optional] |
+| **avg_share_of_voice** | **Float** | Null when no project reports a share of voice. | [optional] |
+| **avg_mention_rate** | **Integer** |  | [optional] |
+| **avg_mention_position** | **Float** | 1-based rank; LOWER is better. | [optional] |
+| **avg_positivity_index** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetOrganizationOverview200ResponseAggregate.new(
+  project_count: null,
+  projects_with_data: null,
+  total_tracked_queries: null,
+  avg_share_of_voice: null,
+  avg_mention_rate: null,
+  avg_mention_position: null,
+  avg_positivity_index: null
+)
+```
+

data/docs/GetOrganizationOverview200ResponseProjectsInner.md

@@ -0,0 +1,32 @@
+# Mencoro::GetOrganizationOverview200ResponseProjectsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **tracked_query_count** | **Integer** |  | [optional] |
+| **share_of_voice** | **Float** | 0-100 percentage share of weighted AI mentions against all tracked brands; higher is better. Null when the project has no rank data yet. | [optional] |
+| **mention_rate** | **Integer** | 0-100 percentage of tracked queries with a result; higher is better. Null when the project has no rank data yet. | [optional] |
+| **avg_mention_position** | **Float** | 1-based average rank of the brand within the answer; LOWER is better. Null when the project has no rank data yet. | [optional] |
+| **positivity_index** | **Integer** | 0-100 sentiment score; higher is better. Null when the project has no rank data yet. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetOrganizationOverview200ResponseProjectsInner.new(
+  project_id: null,
+  name: null,
+  status: null,
+  tracked_query_count: null,
+  share_of_voice: null,
+  mention_rate: null,
+  avg_mention_position: null,
+  positivity_index: null
+)
+```
+

data/docs/GetOrganizationStats200Response.md

@@ -0,0 +1,22 @@
+# Mencoro::GetOrganizationStats200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **members** | [**GetOrganizationStats200ResponseMembers**](GetOrganizationStats200ResponseMembers.md) |  | [optional] |
+| **projects** | [**GetOrganizationStats200ResponseProjects**](GetOrganizationStats200ResponseProjects.md) |  | [optional] |
+| **invitations** | [**GetOrganizationStats200ResponseInvitations**](GetOrganizationStats200ResponseInvitations.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetOrganizationStats200Response.new(
+  members: null,
+  projects: null,
+  invitations: null
+)
+```
+

data/docs/GetOrganizationStats200ResponseInvitations.md

@@ -0,0 +1,18 @@
+# Mencoro::GetOrganizationStats200ResponseInvitations
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pending** | **Integer** | Invitations still awaiting an answer. Accepted, cancelled and expired ones are excluded. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetOrganizationStats200ResponseInvitations.new(
+  pending: 3
+)
+```
+

data/docs/GetOrganizationStats200ResponseMembers.md

@@ -0,0 +1,18 @@
+# Mencoro::GetOrganizationStats200ResponseMembers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Active memberships. Suspended members are excluded. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetOrganizationStats200ResponseMembers.new(
+  total: 12
+)
+```
+

data/docs/GetOrganizationStats200ResponseProjects.md

@@ -0,0 +1,20 @@
+# Mencoro::GetOrganizationStats200ResponseProjects
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Every project in the organization, archived ones included. | [optional] |
+| **active** | **Integer** | Projects that are not archived; never greater than `total`. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetOrganizationStats200ResponseProjects.new(
+  total: 25,
+  active: 18
+)
+```
+

data/docs/GetShareOfVoiceFormula200Response.md

@@ -0,0 +1,24 @@
+# Mencoro::GetShareOfVoiceFormula200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mention_type_weights** | **Hash<String, Float>** | Base weight per mention type; higher means a structurally stronger brand association. | [optional] |
+| **sentiment_multipliers** | **Hash<String, Float>** | Multiplier per tone, applied on top of the base weight. | [optional] |
+| **direct_multiplier** | **Float** | Applied when the mention carries no condition. | [optional] |
+| **conditional_multiplier** | **Float** | Applied instead when the answer hedged the mention with a condition. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetShareOfVoiceFormula200Response.new(
+  mention_type_weights: null,
+  sentiment_multipliers: null,
+  direct_multiplier: null,
+  conditional_multiplier: null
+)
+```
+

data/docs/GetTrackingCoverage200Response.md

@@ -0,0 +1,30 @@
+# Mencoro::GetTrackingCoverage200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** |  | [optional] |
+| **total** | **Integer** | Every tracked query on the project, whatever its status | [optional] |
+| **active** | **Integer** | Tracked queries currently being checked | [optional] |
+| **paused** | **Integer** | Tracked queries whose checks are suspended | [optional] |
+| **never_checked** | **Integer** | Active queries that have never run yet | [optional] |
+| **overdue** | **Integer** | Active queries past their check-frequency interval, never-checked ones excluded | [optional] |
+| **sample** | [**Array<GetTrackingCoverage200ResponseSampleInner>**](GetTrackingCoverage200ResponseSampleInner.md) | Up to 20 overdue queries, oldest check first | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetTrackingCoverage200Response.new(
+  project_id: null,
+  total: null,
+  active: null,
+  paused: null,
+  never_checked: null,
+  overdue: null,
+  sample: null
+)
+```
+

data/docs/GetTrackingCoverage200ResponseSampleInner.md

@@ -0,0 +1,28 @@
+# Mencoro::GetTrackingCoverage200ResponseSampleInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracked_query_id** | **String** |  | [optional] |
+| **query_text** | **String** |  | [optional] |
+| **engine** | **String** |  | [optional] |
+| **country** | **String** | ISO-3166 alpha-2 code | [optional] |
+| **check_frequency** | **String** |  | [optional] |
+| **last_checked_at** | **Time** | RFC 3339 timestamp of the last check. Null means never checked, which this sample never contains. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::GetTrackingCoverage200ResponseSampleInner.new(
+  tracked_query_id: null,
+  query_text: null,
+  engine: null,
+  country: null,
+  check_frequency: null,
+  last_checked_at: null
+)
+```
+

data/docs/InvitationResource.md

@@ -0,0 +1,30 @@
+# Mencoro::InvitationResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **email** | **String** |  |  |
+| **role** | **String** |  |  |
+| **state** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **expires_at** | **Time** |  |  |
+| **accepted_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::InvitationResource.new(
+  id: null,
+  email: null,
+  role: null,
+  state: null,
+  created_at: null,
+  expires_at: null,
+  accepted_at: null
+)
+```
+

data/docs/InvitationsApi.md

@@ -0,0 +1,243 @@
+# Mencoro::InvitationsApi
+
+All URIs are relative to *https://api.mencoro.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_invitation**](InvitationsApi.md#cancel_invitation) | **POST** /api/v1/organizations/{organizationId}/invitations/{invitationId}/cancel | Cancel a pending invitation |
+| [**create_invitation**](InvitationsApi.md#create_invitation) | **POST** /api/v1/organizations/{organizationId}/invitations | Invite somebody to an organization |
+| [**list_invitations**](InvitationsApi.md#list_invitations) | **GET** /api/v1/organizations/{organizationId}/invitations | List an organization's invitations |
+
+
+## cancel_invitation
+
+> <InvitationResource> cancel_invitation(organization_id, invitation_id, x_mencoro_confirmation, idempotency_key)
+
+Cancel a pending invitation
+
+Minimum role: owner. The link already emailed to the invitee stops working. Only a pending invitation can be cancelled; one that was accepted, rejected or has expired is refused.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mencoro'
+# setup authorization
+Mencoro.configure do |config|
+  # Configure Bearer authorization: ApiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mencoro::InvitationsApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+invitation_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+x_mencoro_confirmation = 'x_mencoro_confirmation_example' # String | 
+idempotency_key = 'idempotency_key_example' # String | 
+
+begin
+  # Cancel a pending invitation
+  result = api_instance.cancel_invitation(organization_id, invitation_id, x_mencoro_confirmation, idempotency_key)
+  p result
+rescue Mencoro::ApiError => e
+  puts "Error when calling InvitationsApi->cancel_invitation: #{e}"
+end
+```
+
+#### Using the cancel_invitation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvitationResource>, Integer, Hash)> cancel_invitation_with_http_info(organization_id, invitation_id, x_mencoro_confirmation, idempotency_key)
+
+```ruby
+begin
+  # Cancel a pending invitation
+  data, status_code, headers = api_instance.cancel_invitation_with_http_info(organization_id, invitation_id, x_mencoro_confirmation, idempotency_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvitationResource>
+rescue Mencoro::ApiError => e
+  puts "Error when calling InvitationsApi->cancel_invitation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **invitation_id** | **String** |  |  |
+| **x_mencoro_confirmation** | **String** |  |  |
+| **idempotency_key** | **String** |  |  |
+
+### Return type
+
+[**InvitationResource**](InvitationResource.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_invitation
+
+> <CreateInvitation200Response> create_invitation(organization_id, x_mencoro_confirmation, idempotency_key, create_invitation_request)
+
+Invite somebody to an organization
+
+Minimum role: owner. Sends an invitation email that expires after 14 days. If the address already belongs to an active member the call succeeds and creates nothing - answered as 200 with created=false rather than 201, so a client can tell the two apart. Preview it first; the preview says which of the two will happen.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mencoro'
+# setup authorization
+Mencoro.configure do |config|
+  # Configure Bearer authorization: ApiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mencoro::InvitationsApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+x_mencoro_confirmation = 'x_mencoro_confirmation_example' # String | 
+idempotency_key = 'idempotency_key_example' # String | 
+create_invitation_request = Mencoro::CreateInvitationRequest.new # CreateInvitationRequest | 
+
+begin
+  # Invite somebody to an organization
+  result = api_instance.create_invitation(organization_id, x_mencoro_confirmation, idempotency_key, create_invitation_request)
+  p result
+rescue Mencoro::ApiError => e
+  puts "Error when calling InvitationsApi->create_invitation: #{e}"
+end
+```
+
+#### Using the create_invitation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateInvitation200Response>, Integer, Hash)> create_invitation_with_http_info(organization_id, x_mencoro_confirmation, idempotency_key, create_invitation_request)
+
+```ruby
+begin
+  # Invite somebody to an organization
+  data, status_code, headers = api_instance.create_invitation_with_http_info(organization_id, x_mencoro_confirmation, idempotency_key, create_invitation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateInvitation200Response>
+rescue Mencoro::ApiError => e
+  puts "Error when calling InvitationsApi->create_invitation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **x_mencoro_confirmation** | **String** |  |  |
+| **idempotency_key** | **String** |  |  |
+| **create_invitation_request** | [**CreateInvitationRequest**](CreateInvitationRequest.md) |  |  |
+
+### Return type
+
+[**CreateInvitation200Response**](CreateInvitation200Response.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_invitations
+
+> <ListInvitations200Response> list_invitations(organization_id, opts)
+
+List an organization's invitations
+
+Minimum role: owner. Returns the invitations issued for this organization, in every state. The invitation token is never returned. `status` matches the stored state, so an invitation that has passed its `expiresAt` is still listed as pending until it is transitioned; compare `expiresAt` to decide. Rows are ordered by the chosen sort field, and invitations sharing the same value keep no guaranteed relative order across pages.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. Cells beginning with `=`, `+`, `-` or `@` are prefixed with an apostrophe so a spreadsheet treats them as text rather than running them as formulas.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mencoro'
+# setup authorization
+Mencoro.configure do |config|
+  # Configure Bearer authorization: ApiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mencoro::InvitationsApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  limit: 56, # Integer | 
+  offset: 56, # Integer | 
+  search: 'search_example', # String | Matches part of the invited email address.
+  status: 'pending', # String | Absent means every state.
+  sort_by: 'createdAt', # String | 
+  sort_order: 'asc' # String | 
+}
+
+begin
+  # List an organization's invitations
+  result = api_instance.list_invitations(organization_id, opts)
+  p result
+rescue Mencoro::ApiError => e
+  puts "Error when calling InvitationsApi->list_invitations: #{e}"
+end
+```
+
+#### Using the list_invitations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListInvitations200Response>, Integer, Hash)> list_invitations_with_http_info(organization_id, opts)
+
+```ruby
+begin
+  # List an organization's invitations
+  data, status_code, headers = api_instance.list_invitations_with_http_info(organization_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListInvitations200Response>
+rescue Mencoro::ApiError => e
+  puts "Error when calling InvitationsApi->list_invitations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **limit** | **Integer** |  | [optional][default to 20] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+| **search** | **String** | Matches part of the invited email address. | [optional] |
+| **status** | **String** | Absent means every state. | [optional] |
+| **sort_by** | **String** |  | [optional][default to &#39;createdAt&#39;] |
+| **sort_order** | **String** |  | [optional][default to &#39;desc&#39;] |
+
+### Return type
+
+[**ListInvitations200Response**](ListInvitations200Response.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/csv
+

data/docs/JobsApi.md

@@ -0,0 +1,79 @@
+# Mencoro::JobsApi
+
+All URIs are relative to *https://api.mencoro.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_async_job**](JobsApi.md#get_async_job) | **GET** /api/v1/organizations/{organizationId}/jobs/{jobId} | Get an asynchronous job |
+
+
+## get_async_job
+
+> <AsyncJobResource> get_async_job(organization_id, job_id)
+
+Get an asynchronous job
+
+Minimum role: manager. The status of one asynchronous job started inside this organization — geo prompt discovery, keyword discovery, query clustering, brand discovery or brand-name suggestion — and, once it has completed, its result. Poll it until `status` is terminal: `completed` or `failed`. A null `result` means the result is not known, either because the job is still in flight or because it failed; it never means the job produced an empty result. A failed job carries no reason: the stored one is an internal exception message, not a published field. A job started by another organization, a job of a type this API does not publish, and a job id that does not exist all answer 404 alike, so the API never confirms that an inaccessible job exists.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mencoro'
+# setup authorization
+Mencoro.configure do |config|
+  # Configure Bearer authorization: ApiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mencoro::JobsApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+job_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must be a job started inside the organization in the path.
+
+begin
+  # Get an asynchronous job
+  result = api_instance.get_async_job(organization_id, job_id)
+  p result
+rescue Mencoro::ApiError => e
+  puts "Error when calling JobsApi->get_async_job: #{e}"
+end
+```
+
+#### Using the get_async_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncJobResource>, Integer, Hash)> get_async_job_with_http_info(organization_id, job_id)
+
+```ruby
+begin
+  # Get an asynchronous job
+  data, status_code, headers = api_instance.get_async_job_with_http_info(organization_id, job_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncJobResource>
+rescue Mencoro::ApiError => e
+  puts "Error when calling JobsApi->get_async_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **job_id** | **String** | Must be a job started inside the organization in the path. |  |
+
+### Return type
+
+[**AsyncJobResource**](AsyncJobResource.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/KeywordListingResource.md

@@ -0,0 +1,88 @@
+# Mencoro::KeywordListingResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keyword** | **String** | The keyword as a human types it, picked from the variants for display. |  |
+| **keyword_normalized** | **String** | The grouping key: the keyword lower-cased and unaccented. Unique within the project, and the stable way to match a row across pages. |  |
+| **variant_count** | **Integer** | Tracked queries behind this row that the current filters selected. |  |
+| **variant_ids** | **Array<String>** | Ids of those tracked queries. Accepted by the single tracked-query operation. |  |
+| **engines** | **Array<String>** | Distinct engines across the variants, not a single engine. |  |
+| **countries** | **Array<String>** | Distinct ISO-3166 alpha-2 countries across the variants. |  |
+| **query_cluster_ids** | **Array<String>** | Distinct keyword clusters the variants belong to. Empty when none of them is clustered. |  |
+| **has_unclustered_variant** | **Boolean** | Whether at least one variant belongs to no cluster. |  |
+| **status_summary** | **String** | \"mixed\" when the variants disagree; otherwise the one status they share. |  |
+| **statuses** | **Array<String>** | Distinct statuses across the variants. |  |
+| **check_frequencies** | **Array<String>** | Distinct check frequencies across the variants. |  |
+| **n_passes_values** | **Array<Integer>** | Distinct pass counts across the variants. A pass is one budget unit per check. |  |
+| **last_checked_at** | **Time** | The most recent completed check across the variants. Null when none has ever completed — not a check that found nothing. | [optional] |
+| **avg_serp_position** | **Float** | Average position in traditional search over the window. 1-based, LOWER is better. | [optional] |
+| **trend_serp** | **Float** | Signed improvement in avgSerpPosition against the previous window. Positive is better. | [optional] |
+| **avg_shopping_position** | **Float** | Average position in shopping results over the window. 1-based, LOWER is better. | [optional] |
+| **trend_shopping** | **Float** | Signed improvement in avgShoppingPosition. Positive is better. | [optional] |
+| **avg_mention_position** | **Float** | Average position of the brand mention inside the AI answer. 1-based, LOWER is better. | [optional] |
+| **trend_mention** | **Float** | Signed improvement in avgMentionPosition. Positive is better. | [optional] |
+| **avg_link_position** | **Float** | Average position of a cited link to the brand. 1-based, LOWER is better. | [optional] |
+| **trend_link** | **Float** | Signed improvement in avgLinkPosition. Positive is better. | [optional] |
+| **mention_position_stability** | **Float** | Day-to-day spread of the mention position (a standard deviation): LOWER means steadier. | [optional] |
+| **trend_stability** | **Float** | Signed improvement in mentionPositionStability. Positive means steadier than the previous window. | [optional] |
+| **positivity_index** | **Integer** | 0-100 weighted sentiment score of the mentions; HIGHER is better. Null when there were no mentions to score. | [optional] |
+| **trend_positivity** | **Integer** | Signed improvement in positivityIndex. Positive is better. | [optional] |
+| **mention_rate** | **Integer** | 0-100 share of AI captures in the window that mentioned the brand; HIGHER is better. | [optional] |
+| **trend_mention_rate** | **Integer** | Signed improvement in mentionRate. Positive is better. | [optional] |
+| **serp_rate** | **Integer** | 0-100 share of traditional-search captures in the window that ranked the brand; HIGHER is better. | [optional] |
+| **trend_serp_rate** | **Integer** | Signed improvement in serpRate. Positive is better. | [optional] |
+| **share_of_voice** | **Float** | 0-100 share of the weighted AI mentions against every tracked brand; HIGHER is better. | [optional] |
+| **trend_share_of_voice** | **Float** | Signed improvement in shareOfVoice. Positive is better. | [optional] |
+| **sentiment_positive** | **Integer** | Positive brand mentions counted in the window. Zero here really is zero. |  |
+| **sentiment_neutral** | **Integer** | Neutral brand mentions counted in the window. |  |
+| **sentiment_negative** | **Integer** | Negative brand mentions counted in the window. |  |
+| **avg_mention_count** | **Float** | Mentions per AI engine per day with a capture, over the window. Not a total: the window total is not part of this contract. | [optional] |
+| **mention_type_counts** | [**KeywordListingResourceMentionTypeCounts**](KeywordListingResourceMentionTypeCounts.md) |  |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::KeywordListingResource.new(
+  keyword: null,
+  keyword_normalized: null,
+  variant_count: null,
+  variant_ids: null,
+  engines: null,
+  countries: null,
+  query_cluster_ids: null,
+  has_unclustered_variant: null,
+  status_summary: null,
+  statuses: null,
+  check_frequencies: null,
+  n_passes_values: null,
+  last_checked_at: null,
+  avg_serp_position: null,
+  trend_serp: null,
+  avg_shopping_position: null,
+  trend_shopping: null,
+  avg_mention_position: null,
+  trend_mention: null,
+  avg_link_position: null,
+  trend_link: null,
+  mention_position_stability: null,
+  trend_stability: null,
+  positivity_index: null,
+  trend_positivity: null,
+  mention_rate: null,
+  trend_mention_rate: null,
+  serp_rate: null,
+  trend_serp_rate: null,
+  share_of_voice: null,
+  trend_share_of_voice: null,
+  sentiment_positive: null,
+  sentiment_neutral: null,
+  sentiment_negative: null,
+  avg_mention_count: null,
+  mention_type_counts: null
+)
+```
+