Extractions

Changed on

Downloads completed extraction results in the requested format. JSON rows also keep each result's nested enrichmentData, as GET /extractions/{id} returns it.

get/api/v1/extractions/{id}/export

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/extractions/{id}/export
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required
Example:L3NjAbCdEfGh

Extraction ID returned by POST /extractions or the extraction list. Another shape gets 400 invalid_id.

Query parameters

format'csv' | 'json' | 'md' | 'md-document' | 'pdf' | 'txt' | 'xlsx' required

Export file format

minFollowersinteger

Whole number from 0.

Minimum follower count.

maxFollowersinteger

Whole number from 0.

Maximum follower count.

minFollowinginteger

Whole number from 0.

Minimum following count.

maxFollowinginteger

Whole number from 0.

Maximum following count.

minPostsinteger

Whole number from 0.

Minimum post count.

maxPostsinteger

Whole number from 0.

Maximum post count.

minLikesinteger

Whole number from 0.

Minimum like count.

minRepliesinteger

Whole number from 0.

Minimum reply count.

minRetweetsinteger

Whole number from 0.

Minimum repost count.

minViewsinteger

Whole number from 0.

Minimum view count.

hasDescriptionboolean

Require a non-empty description.

hasLocationboolean

Require a non-empty location.

hasEmailboolean

Require an email in the row's Email column.

businessEmailOnlyboolean

Require an email outside free webmail, such as Gmail, in the row's Email column.

emailDomainsstring

Require the row's email at one of these domains. Separate domains with commas. Subdomains match.

hasMediaboolean

Require media.

verifiedboolean

Filter by verified status.

langstring

Filter by language code.

searchstring

Search exported result text.

sinceDatestring date

Include results on or after this date, from 00:00 UTC. An ISO 8601 time starts at that instant. The filter drops results without a post date. An empty value sets no filter.

untilDatestring date

Include results on or before this date, inclusive, through 23:59:59 UTC. An ISO 8601 time ends at that instant. The filter drops results without a post date. An empty value sets no filter.

Response

Exported file

Changes

  • 45942c75fdc2Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status