Batch Searching for Play Log Overviews

POST

/v2/logs/play-logs/batch-summary

TIP

This interface is used for batch obtaining the play log overviews of players.

An organization user have only one play log search task running at a time and must await the completion of the previous task before submitting a new one.

The logs will be stored in our cloud space in the form of an Excel file and will be sent to the customer as a link. Please download and use it as needed.

The logs within the past 3 months can be found, containing the logs of the start date, The logs within the past 30 consecutive days at most can be found. The logs only before the end date can be found.

The Excel file can be retained in our cloud space for 7 days, and the file will be automatically deleted after 7 days. Please complete the download and transfer within 7 days.

Advanced interface.

Request

Header Params

AppKey

string

required

Access key

Default:

Nonce

string

required

Random string (8-64 characters, only numbers or letters)

CurTime

string

required

The current UTC timestamp

CheckSum

string

required

Request signature

Body Params application/json

playerIds

array[string]

required

A collection of player IDs to be handled. At most 100 player can be handled simultaneously.

startDate

string

required

Start date, in a format such as 2020-05-06 (The logs within the past 3 months can be found, containing the logs of the start date.)

endDate

string

required

End date, in a format such as 2020-05-12 (The logs within the past 30 consecutive days at most can be found. The logs only before the end date can be found.)

noticeUrl

string

required

After the log is processed successfully, the system will call back this address and send it to the customer in the form of [POST-JSON]. The response time of the interface cannot exceed 3s. The interface of the customer must return the "ok" string, otherwise the system will retry.

Example

{
  "playerIds": [
    "df6c02352e4fd3cd5bc664fcdaef29c9"
  ],
  "startDate": "2024-06-01",
  "endDate": "2024-06-19",
  "noticeUrl": "http://sit-api.vnnox.com/test/noticeScreenShotUrl"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-us.vnnox.com/v2/logs/play-logs/batch-summary' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "playerIds": [
    "df6c02352e4fd3cd5bc664fcdaef29c9"
  ],
  "startDate": "2024-06-01",
  "endDate": "2024-06-19",
  "noticeUrl": "http://sit-api.vnnox.com/test/noticeScreenShotUrl"
}'

Responses

🟢200成功

application/json

Body

taskId

string

required

No. of the current search task

Example

{
  "taskId": "5"
}

🟢200Call-back Parameters for Notifying Users of Play Log Information

Modified at 2024-08-07 01:35:37

Scheduled Video Source Switching

Batch Searching for Play Log Details