Skip to main content

Retrieve documents from global index

GET
api/v1/search/results

Retrieve up to 500 sorted results for a given timeframe within the last 30 days.

Query Parameters

  • q string required

    The query to search for.

    Example: cats AND dogs
  • offset integer

    Number of results to skip (for paging). Vaule is between 0 and 500. Default value: 0.

    Example: 0
  • hpp integer

    Number of hits per page (for paging). Allowed value is between 0 and 500. Default value: 10.

    Example: 10
  • sort_by string

    Criteria for sorting the results. Allowed values: engagement, published, reach, facebook_shares, facebook_likes, twitter_shares, twitter_retweets, twitter_followers, youtube_likes, youtube_dislikes, youtube_views, cluster_size, comment_count, published, search_indexed, trending_score. Default value is engagement.

    Example: engagement
  • sort_order string

    Sorting order (ascending or descending). Allowed values: asc, desc Default value: desc.

    Example: desc
  • hl boolean

    Turns highlighting on or off. Allowed values: true or false. Default value: true.

    Example: true
  • pretty boolean

    Formatted json for testing. Allowed values: true or false. Default value: false.

    Example: false
Responses

OK


Schema
  • object
Loading...