List mentions

ID of the Topic.

Filter mentions published on or after this date. Format - yyyy-MM-ddThh:mm:ss, with an optional UTC offset. Without an offset the value is interpreted in the timeZone parameter's zone, which defaults to the API key owner's time zone (see Dates and time zones in the Mentions section). Default - 6 days before today.

Filter mentions published till the to date, inclusive: the effective upper bound is to plus one day. to=2018-06-08 includes the whole of June 8; to=2018-06-08T04:20Z includes mentions up to (but excluding) June 9, 04:20Z. Format and time zone interpretation are the same as for from. Default - today.

Filter mentions that were added to the topic after this date. Format - yyyy-MM-ddThh:mm:ss. Unlike published, this is the moment YouScan saved the mention — useful for catching mentions collected with a delay. Note: unlike to, addedTo is not extended by a day.

Filter mentions that were added to the topic before this date. Format - yyyy-MM-ddThh:mm:ss.

Cursor filter: return only mentions with seq greater than this value (exclusive). Combine with orderBy=seqAsc and pass the highest seq from the previous page — see How to effectively retrieve large sets of mentions for the full loop.

Filter mentions matching the specified sentiment. Multiple values are supported.

Exclude mentions matching the specified sentiment. Multiple values are supported.

Filter mentions with engagement count greater than or equal to this value.

Filter mentions with engagement count less than or equal to this value.

Filter mentions where engagement data was collected after this date. Format - yyyy-MM-ddThh:mm:ss.

Filter mentions where engagement data was collected before this date. Format - yyyy-MM-ddThh:mm:ss.

Filter mentions by source. Multiple values are supported.

Exclude mentions by source. Multiple values are supported.

Filter mentions by source type. Multiple values are supported.

Exclude mentions by source type. Multiple values are supported.

Filter mentions by post type. Multiple values are supported.

Exclude mentions by post type. Multiple values are supported.

Filter mentions by tag names. Multiple values are supported. Returns a validation error if a tag with the given name does not exist in the topic.

Exclude mentions by tag names. Multiple values are supported.

Filter mentions by auto categories. Multiple values are supported.

Exclude mentions by auto categories. Multiple values are supported.

Use true to get only starred mentions.

Use true to get mentions containing any tag. Use false to get mentions without any tags. Omit the parameter to get all mentions regardless of tags.

Use true to get processed mentions. Use false to get unprocessed mentions. Omit the parameter to get all mentions regardless of processed status.

Use true to get mentions that were moved to Bin.

Use true to get mentions that were marked as spam.

Additionally filter mentions by a text query using YouScan query syntax.

Use true to group near-duplicate mentions by text and return only one mention per group.

Whether to sanitize mention text to be consumed as HTML. Use false to get raw unescaped text.

IANA time zone identifier (e.g. Europe/Kyiv) used to interpret date parameters that have no explicit offset. Defaults to the API key owner's time zone. To reproduce the numbers a platform user sees in the UI, pass that user's time zone here.

Limits the number of mentions per page. Default - 10, maximum - 1000. The response total field tells how many mentions match in total — if it exceeds size, paginate with the sinceSeq cursor.

Number of mentions to skip. Used for paging; must be less than 10000. To page deeper than that, use the sinceSeq cursor instead.

Sorting field.