For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

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

Was this helpful?