Class FetchArgs

Options specifying the data that is to be fetched.

Implements

Constructors

constructor

Properties

activeConversationId? conversationId? count? cursor? filter? fromTime? granularity? id? ids? maxId? metrics? showVerifiedFollowers? sortBy? toTime?

Constructors

constructor

Properties

OptionalactiveConversationId

activeConversationId?: string

The id of the active conversation.

Remarks

  • Required only for ResourceType.DM_USER_UPDATES.

OptionalconversationId

conversationId?: string

The id of the conversation to fetch.

Remarks

Optionalcount

count?: number

The number of data items to fetch.

Remarks

Optionalcursor

cursor?: string

The cursor to the batch of data to fetch.

Remarks

  • May be used for cursored resources.
  • Has no effect for other resources.

Optionalfilter

filter?: TweetFilter

The filter for searching tweets.

Remarks

Required when searching for tweets using ResourceType.TWEET_SEARCH.

OptionalfromTime

fromTime?: Date

The date to start fetching data from.

Remarks

  • Only works for EResourceType.USER_ANALYTICS.

Optionalgranularity

granularity?: RawAnalyticsGranularity

The granularity of the data to fetch.

Remarks

  • Only works for EResourceType.USER_ANALYTICS.

Optionalid

id?: string

The id of the target resource.

Remarks

Optionalids

ids?: string[]

The IDs of the target resources.

Remarks

OptionalmaxId

maxId?: string

The maximum id of the data to fetch.

Remarks

Optionalmetrics

metrics?: RawAnalyticsMetric[]

The metrics to fetch.

Remarks

  • Only works for EResourceType.USER_ANALYTICS.

OptionalshowVerifiedFollowers

showVerifiedFollowers?: boolean

Show the verified follower count and relationship counts in the response.

Remarks

  • Only works for EResourceType.USER_ANALYTICS.

OptionalsortBy

sortBy?: TweetRepliesSortType

The sorting to use for tweet results.

Remarks

OptionaltoTime

toTime?: Date

The date to end fetching data at.

Remarks

  • Only works for EResourceType.USER_ANALYTICS.

Settings

Member Visibility

On This Page

Constructors
Properties