API Documentation

This is the documentation for the available API endpoints, which are built around the REST architecture. All the API endpoints will return a JSON response with the standard HTTP response codes and need a Bearer Authentication via an API Key.

Authentication

All the API endpoints require an API key sent by the Bearer Authentication method.

curl --request GET \
--url 'https://youranalyzer.com/api/{endpoint}' \
--header 'authorization: Bearer {api_key}' \

External Users

This API endpoint is responsible for all the external users (TikTok users) related data.

Retrieve a user

This endpoint is made to retrieve the details of a TikTok user and their day by day logs.

GET https://youranalyzer.com/api/external_users/tiktok/{username}?start_date={start_date}&end_date={end_date}
Example
curl --request GET \
--url 'https://youranalyzer.com/api/external_users/tiktok/tiktok' \
--header 'authorization: Bearer {api_key}' \
Example
curl --request GET \
--url 'https://youranalyzer.com/api/external_users/tiktok/tiktok?start_date=2020-07-22&end_date=2020-07-23' \
--header 'authorization: Bearer {api_key}' \
Response example
{
    "user": {
        "external_id": "107955",
        "username": "tiktok",
        "name": "TikTok",
        "description": "Make Your Day",
        "avatar_url": "https:\/\/p16-va-tiktok.ibyteimg.com\/img\/musically-maliva-obj\/1645136815763462~c5_720x720.jpeg",
        "followers": "44100000",
        "previous_followers": "44100000",
        "following": "490",
        "previous_following": "490",
        "videos": "103",
        "previous_videos": "103",
        "likes": "223500000",
        "previous_likes": "223500000",
        "is_verified": "1",
        "is_demo": "0",
        "current_month_pageviews": "1",
        "total_pageviews": "1",
        "date": "2020-06-28 11:20:33",
        "last_date": "2020-07-23 07:23:47",
        "previous_date": "2020-07-22 17:14:03"
    },
    "user_logs": [
        {
            "user_external_id": "107955",
            "followers": "44100000",
            "followers_growth": "0",
            "following": "490",
            "following_growth": "0",
            "videos": "103",
            "videos_growth": "0",
            "likes": "223500000",
            "likes_growth": "0",
            "is_generated": "0",
            "date_day": "2020-07-23"
        },
        {
            "user_external_id": "107955",
            "followers": "44100000",
            "followers_growth": "33334",
            "following": "490",
            "following_growth": "0",
            "videos": "103",
            "videos_growth": "0",
            "likes": "223500000",
            "likes_growth": "33334",
            "is_generated": "0",
            "date_day": "2020-07-22"
        }
    ]
}
                        

Parameters

username Required

The username for the TikTok account that is requested.

start_date Optional

The start date for when the logs should be retrieved; Iin Y-m-d format.

end_date Optional

The end date for when the logs should be retrieved; In Y-m-d format.