Unlocked Reports

Returns a list of reports unlocked on the requested account

Endpoint

JSON

GET https://hypeauditor.com/api/method/auditor.reportsUnlocked

Parameters Object

Attribute	Type	Description
limit	int	default = 100, maximum = 100
date_from	date	Start date for the period to analyze (corresponds to time_pay). ISO format (yyyy-mm-dd hh:mm:ss)
date_to	date	Final date for the period to analyze (corresponds to time_pay). ISO format (yyyy-mm-dd hh:mm:ss)
offset	int	default = 0

📘

Note:

• All the attributes are optional.
• Endpoint is available only for API subscriptions.
• Ifdate_from and date_to are not specified, the time since account creation till now is used.
• If date attributes do not include hh:mm:ss, the default is 00:00:00 (e.g.: 2024-01-01 = 2024-01-01 00:00:00).

Response Object

Attributes	Type
data.username	str	Username of unlocked report
data.id	str	ID of unlocked report
data.type	str	Social Network
data.time_add	timestamp	Unix timestamp in seconds when report was requested
data.time_pay	timestamp	Unix timestamp in seconds when report was paid
data.completed	int	1 - Ready 0 - Not Ready
data.time_completed	timestamp	Unix timestamp in seconds when report was completed
total	int	Total amount of reports in data object

Requests

Set YOUR_ID and YOUR_TOKEN from HypeAuditor.

Curl Request

curl -X GET \
  'https://hypeauditor.com/api/method/auditor.reportsUnlocked?limit=10&date_from=2024-09-18&date_to=2024-09-20&offset=0'
  -H 'x-auth-id: %YOUR_ID%' \
  -H 'x-auth-token: %YOUR_TOKEN%' \

PHP Request

<?php
$curl = curl_init();
curl_setopt_array($curl, [
   CURLOPT_URL => 'https://hypeauditor.com/api/method/auditor.reportsUnlocked?limit=10&date_from=2024-09-18&date_to=2024-09-20&offset=0',
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => [
       'x-auth-id: YOUR_ID',
       'x-auth-token: YOUR_TOKEN'
   ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
   echo 'cURL Error #:' . $err;
} else {
   echo $response;
}

Sample Response

JSON

{
    "result": {
        "data": [
            {
                "username": "padel_ligita",
                "id": "48298939035",
                "type": "instagram",
                "time_add": 1726728742,
                "time_pay": 1726728750,
                "completed": 1,
                "time_completed": 1726728742
            }
        ],
        "total": 1
    }
}

Errors

• Please, refer to Errors.