Data Requests API

POST - Create Request

This API is used for getting basic analytics for a creator or a post.

curl --location 'https://dashboard.ylytic.com/ylytic/admin/api/v1/data_requests' \
--header 'Authorization: {{auth_token}}' \
--data-raw '{
    "request_type":"creators",
    "request_entries":["https://www.youtube.com/@sochbymm"]
}'

POST PARAMS

ATTRIBUTESDESCRIPTION

request_type

to identify the type of creator.

request_entries

the url of the handle of the creator.

PAYLOAD

{
    "request_type":"creators",
    "request_entries":["https://www.youtube.com/@sochbymm"]
}

OUTPUT(JSON)

{
    "data_request_id": "658ab33999517fffa1cc4dc0",
    "status": "initiated"
}

GET – Get Request

This is used to get the request from the creator.

curl --location 'https://dashboard.ylytic.com/ylytic/admin/api/v1/data_requests/658ab33999517fffa1cc4dc0' \
--header 'Authorization: {{auth_token}}'

OUTPUT (JSON)

{
    "id": "658ab33999517fffa1cc4dc0",
    "request_type": "creators",
    "processed_entries": 1,
    "success_entries": 1,
    "created_date": "Tue, 26 Dec 2023 11:04:25 GMT",
    "status": "success",
    "request_entries": [
        "https://www.youtube.com/@sochbymm"
    ],
    "response_entries": [
        {
            "request_entry": "https://www.youtube.com/@sochbymm",
            "platform": "youtube",
            "handle": "UCz4a7agVFr1TxU-mpAP8hkw",
            "status": "success",
            "status_reason": "success",
            "url": "https://youtube.com/channel/UCz4a7agVFr1TxU-mpAP8hkw",
            "views": 269524663,
            "full_name": "Soch by Mohak Mangal",
            "followers": 2860000,
            "posts": 315,
            "tier": "Mega"
        }
    ]
}

Last updated