Channels Results

Get non-real-time results of channel monitoring

GET https://api-v2.acrcloud.com/api/bm-bd-projects/:pid/channels/:channel_id/results

Path Parameters

Name
Type
Description

pid

number

The project id

channel_id

number

The channel id

Query Parameters

Name
Type
Description

type

string

last: get the last result day: get the day result Default is day.

date

string

get the results for a certain day you specified. The format is YYYYmmdd (E.g. 20210201)

min_duration

number

Only return the results of played_duration greater than or equal to min_duration seconds (default: 0)

max_duration

number

Only return the results of played_duration less than or equal to max_duration seconds (default: 3600)

isrc_country

string

Only return results that match the isrc country code (E.g. DE, FR, IT, US)

with_false_positive

number

0: does not return results marked as false positive. (Default)

1: returns results marked false positive.

Headers

Name
Type
Description

Authorization

string

Bearer token

Accept

string

application/json

{
    "data": [
        {
            "status": {
                "msg": "Success",
                "code": 0,
                "version": "1.0"
            },
            "result_type": 0,
            "metadata": {
                "type": "delay",
                "timestamp_utc": "2021-01-07 10:20:25",
                "played_duration": 117,
                "music": [
                    {
                        "album": {
                            "name": "Shoot For The Stars Aim For The Moon"
                        },
                        "play_offset_ms": 30520,
                        "sample_begin_time_offset_ms": 2420,
                        "title": "What You Know Bout Love",
                        "result_from": 3,
                        "release_date": "2020-07-03",
                        "sample_end_time_offset_ms": 8460,
                        "genres": [
                            {
                                "name": "Hip Hop"
                            }
                        ],
                        "label": "Victor Victor Worldwide",
                        "db_end_time_offset_ms": 29240,
                        "score": 100,
                        "db_begin_time_offset_ms": 23200,
                        "artists": [
                            {
                                "name": "Pop Smoke"
                            }
                        ],
                        "duration_ms": 160000,
                        "external_ids": {
                            "isrc": [
                                "USUM72013339",
                                "USUM72013343",
                                "QZNMT2001964"
                            ],
                            "upc": [
                                "00602507456573",
                                "00602507456672",
                                "00602507456566"
                            ]
                        },
                        "acrid": "dda6ca5475ba126aa02b88ebe9b9b4cd",
                        "external_metadata": {
                            "spotify": [
                                {
                                    "album": {
                                        "name": "Shoot For The Stars Aim For The Moon",
                                        "id": "7e7t0MCrNDcJZsPwUKjmOc"
                                    },
                                    "track": {
                                        "name": "What You Know Bout Love",
                                        "id": "1tkg4EHVoqnhR6iFEXb60y"
                                    },
                                    "artists": [
                                        {
                                            "name": "Pop Smoke",
                                            "id": "0eDvMgVFoNV3TpwtrVCoTj"
                                        }
                                    ]
                                },
                                {
                                    "album": {
                                        "name": "Shoot For The Stars Aim For The Moon",
                                        "id": "3BjyBrktXCnnJ0gHifkyAk"
                                    },
                                    "track": {
                                        "name": "What You Know Bout Love",
                                        "id": "4g7ErSF4oImNnITtyiFowz"
                                    },
                                    "artists": [
                                        {
                                            "name": "Pop Smoke",
                                            "id": "0eDvMgVFoNV3TpwtrVCoTj"
                                        }
                                    ]
                                },
                                {
                                    "album": {
                                        "name": "Shoot For The Stars Aim For The Moon (Deluxe)",
                                        "id": "45HGJedVnKuOXNFW8fVuDz"
                                    },
                                    "track": {
                                        "name": "What You Know Bout Love",
                                        "id": "3jia9xE2RlTZKSy78z1mIz"
                                    },
                                    "artists": [
                                        {
                                            "name": "Pop Smoke",
                                            "id": "0eDvMgVFoNV3TpwtrVCoTj"
                                        }
                                    ]
                                }
                            ],
                            "deezer": [
                                {
                                    "album": {
                                        "name": ""
                                    },
                                    "track": {
                                        "name": "What You Know Bout Love",
                                        "id": "1081877402"
                                    },
                                    "artists": [
                                        {
                                            "name": "Pop Smoke"
                                        }
                                    ]
                                }
                            ]
                        }
                    }
                ],
                "record_timestamp": "20210107102025"
            }
        }
    ]
}

Get real-time results of channel monitoring

GET https://api-v2.acrcloud.com/api/bm-bd-projects/:pid/channels/:channel_id/realtime_results

Path Parameters

Name
Type
Description

pid

number

The project id

channel_id

number

The channel id

Headers

Name
Type
Description

Authorization

string

Bearer token

Accept

string

application/json

The following is a sample script that displays the results in real-time

Getting results not recognized but detected as music. (Note: This API is only available for channels with music detection enabled)

GET https://api-v2.acrcloud.com/api/bm-bd-projects/:pid/channels/:channel_id/unknown_results

Path Parameters

Name
Type
Description

pid*

Number

The project id

channel_id*

Number

channel_id

Query Parameters

Name
Type
Description

date*

String

Get all the results on this date. The format is YYYYmmdd (E.g. 20210201)

min_duration

Number

Only return the results of played_duration greater than or equal to min_duration seconds (default: 0)

max_duration

Number

Only return the results of played_duration less than or equal to max_duration seconds (default: 3600)

Headers

Name
Type
Description

Authorization*

String

Bearer token

Accept*

String

application/json

Last updated