Get Best Users Insight

This endpoint retrieves the best users insights list.

HTTP Request

GET /api/v2/insight/user/

Parameters

Name	In	Type	Required	Description
limit	path	integer	false	Number of results to return per page
offset	path	integer	false	The initial index from which to return the results
category_id	path	string	false	Can be a single category id or list (comma separated) of categories ids. 0 means empty (no category). If you use a list of ids then any user who matches at least one id will be returned (the filter is in OR and not in AND)
user_tag_id	path	string	false	Can be a single user tag id or list (comma separated) of user tag ids. If you use a list of ids then any user who matches at least one id will be returned (the filter is in OR and not in AND)
created_at__gte	path	string(date-time)	false	Datetime of creation(greater than or equal to the given value)
created_at__lte	path	string(date-time)	false	Datetime of creation(less than or equal to the given value)
ranked_by	path	string	false	The rank value to use: num_posts, num_comments, num_answers_received, num_comments_received, num_votes, num_votes_received, num_connections, num_followings, num_followers, num_shares, num_posts_visits, num_embed_custom_click_received (default: rank function). If a list (eg: num_comments, num_answers_received) the final rank will be the sum of the list components
embed_id	path	string	false	The embed id (required in combo with embed_type)
embed_type	path	string	false	The embed type (required in combo with embed_id)

Example Request

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/insight/user/',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Bash

# You can also use wget
curl -X GET /api/v2/insight/user/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Inline

Response Schema

Name	Type	Required	Restrictions	Description
count	integer	false	none	Total results count
next	string(uri)¦null	false	none	Next page url
previous	string(uri)¦null	false	none	Previous page url
results	list	false	none	List of results
» user	User	false	none	A user
» score	integer	false	none	The user score

Example response

{
    "count": "integer",
    "next": "string(uri)",
    "previous": "string(uri)",
    "results": [
        {
            "user": "{User}",
            "score": "integer"
        }
    ]
}