> For the complete documentation index, see [llms.txt](https://docs.roivenue.com/roivenue-resources/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roivenue.com/roivenue-resources/roivenue-training/roivenue-app/data/connectors-overview/list-of-connectors/x-twitter/x-twitter-parameters.md).

# X (Twitter) - Parameters

The query parameters available to a X (Twitter) connector.

These are the parameters a X (Twitter) connector's query accepts. The recommended template sets the ones it needs; the rest are only reachable by editing the connector in the Advanced Editor.

Most accounts never touch these. The page exists so that when a connector does need adjusting, what is adjustable is written down. The columns it can return are listed separately on [X (Twitter) - Supported Columns](/roivenue-resources/roivenue-training/roivenue-app/data/connectors-overview/list-of-connectors/x-twitter/x-twitter-supported-columns.md).

## Parameters

| Parameter                       | Type                      | Default                  | What it does                                                                                                                                                                                                                                                      |
| ------------------------------- | ------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `EntityType`                    | EntityType                |                          | Entity type to retrieve data for.                                                                                                                                                                                                                                 |
| `EntityIds`                     | list of text              |                          | Specific entities to retrieve data for. Specify a comma-separated list of entity IDs. If value is null all entities of given type will be retrieved - this will provide additional entity-specific columns. Null is not supported for ACCOUNT and ORGANIC\_TWEET. |
| `IncludeDeletedEntities`        | true or false             |                          | Value which indicates whether deleted entities should be included in the results.                                                                                                                                                                                 |
| `IncludeDeletedRelatedEntities` | true or false             |                          | Include related entries (see RelatedEntities) even if they are deleted.                                                                                                                                                                                           |
| `MetricGroups`                  | list of MetricGroup       |                          | Specific metrics that should be returned. Specify a comma-separated list of metric groups.                                                                                                                                                                        |
| `Placement`                     | text                      |                          | Placement of metrics to retrieve. Possible values: ALL\_ON\_TWITTER, PUBLISHER\_NETWORK.                                                                                                                                                                          |
| `DerivedMetrics`                | list of text              |                          | Names of derived metrics.                                                                                                                                                                                                                                         |
| `EntityProperties`              | list of text              |                          | Additional properties of entities to retrieve.                                                                                                                                                                                                                    |
| `RelatedEntities`               | list of RelatedEntityType |                          | Types related entities to load                                                                                                                                                                                                                                    |
| `Granularity`                   | JobGranularity            |                          | Granularity of the analytics job. Possible values: DAY, HOUR, TOTAL. Default is DAY.                                                                                                                                                                              |
| `Country`                       | text                      |                          | Country                                                                                                                                                                                                                                                           |
| `Platform`                      | number                    |                          | Platform type.                                                                                                                                                                                                                                                    |
| `SegmentationType`              | TwitterSegmentationType   |                          | Value specifying how the retrieved data should be segmented.                                                                                                                                                                                                      |
| `AnalyticsJobMaxWaitTime`       | TimeSpan                  | TimeSpan.FromMinutes(30) | Maximum single wait interval for Twitter analytics job. Default value is ½h.                                                                                                                                                                                      |
| `AnalyticsJobMaxRetries`        | number                    | 5                        | Maximum number of retry attempts for analytics jobs.                                                                                                                                                                                                              |

## JobGranularity values

| Value   | Meaning |
| ------- | ------- |
| `DAY`   |         |
| `HOUR`  |         |
| `TOTAL` |         |

{% hint style="danger" %}
A connector edited in the Advanced Editor stops receiving template updates. Roivenue ships improvements by updating the shared template a connector is built from, and only connectors still configured by that template pick those updates up. Once a connector is switched to advanced mode, its query and transformations belong to you.
{% endhint %}
