Skip to main content

Interface: InsightCommonParams

types/insight.InsightCommonParams

Interface InsightParams

Hierarchy​

Properties​

category_id​

• Optional category_id: string

Can be a single category id or list (comma separated) of categories ids. 0 means empty (no category). If you use a list of category ids then any contribution that matches at least one category_id will be returned (the filter is in OR and not in AND).

Defined in​

types/insight.ts:11

created_at__gte​

• Optional created_at__gte: string

Datetime of creation(greater than or equal to the given value).

Defined in​

types/insight.ts:15

created_at__lte​

• Optional created_at__lte: string

Datetime of creation(less than or equal to the given value).

Defined in​

types/insight.ts:19

embed_id​

• Optional embed_id: number

The embed id (required in combo with embed_type).

Defined in​

types/insight.ts:27

embed_type​

• Optional embed_type: string

The embed type (required in combo with embed_id).

Defined in​

types/insight.ts:31

limit​

• Optional limit: number

Number of results to return per page.

Inherited from​

BaseGetParams.limit

Defined in​

types/baseParams.ts:9

offset​

• Optional offset: number

The initial index from which to return the results.

Inherited from​

BaseGetParams.offset

Defined in​

types/baseParams.ts:13

ranked_by​

• Optional ranked_by: number

The rank value to use: num_votes, num_comments, num_shares, num_views (default: rank function). If a list (eg: num_comments, num_answers_received) the final rank will be the sum of the list components.

Defined in​

types/insight.ts:23