브랜드 프로필 노출 통계

Request

브랜드프로필 노출 통계를 조회합니다.

브랜드프로필 노출 통계를 조회합니다.

• 브랜드 프로필 이미지가 단말에 표시되면 일자별로 집계됩니다.
• 단말에서 브랜드 프로필은 대화방별로 노출되므로 통계 데이터는 브랜드에 등록된 대화방별 건수로 제공됩니다.
• 통계 조회 기간은 데이터 존재 시 최근 1년 6개월 이내 기간 중 최대 31일까지 검색 가능합니다.

• 계정 권한: 마스터, 매니저, 대행사
• 브랜드 권한: 브랜드 대표운영자, 운영자

get

/statQuery/brandprofile/{brandId}

Authorizations

Path parameters

brandIdstring · max: 13required

maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.

Query parameters

startDatestringrequired

통계 조회 기간 시작일자(yyyymmdd) 입니다.

endDatestringrequired

통계 조회 기간 종료일자(yyyymmdd) 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18

maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.

대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-qa.rcsbizcenter.com/api/1.1/statQuery/brandprofile/{brandId}?startDate=text&endDate=text' \
  --header 'Authorization: Bearer JWT'

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		일자별, 대화방별 브랜드 프로필 노출 통계 Data
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
statDate	string	8			통계일자
chatbotId	string	15			대화방 ID
displayedCount	integer				대화방별 브랜드 프로필 노출 건수

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "statDate": "20240630",
            "chatbotId": "09044196572",
            "displayedCount": 620
        },
        {
            "statDate": "20240629",
            "chatbotId": "09044196572",
            "displayedCount": 636
        },
        {
            "statDate": "20240628",
            "chatbotId": "09044196572",
            "displayedCount": 631
        },
        {
            "statDate": "20240627",
            "chatbotId": "09044196572",
            "displayedCount": 632
        },
        {
            "statDate": "20240626",
            "chatbotId": "09044196572",
            "displayedCount": 609
        },
        {
            "statDate": "20240625",
            "chatbotId": "09044196572",
            "displayedCount": 639
        }
    ],
    "status": 200
}

400

{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "status": 400
}

{
    "error": {
        "code": "64203",
        "message": "query paramter required [chatbotId]"
    },
    "status": 400
}

{
    "error": {
        "code": "64203",
        "message": "query paramter required [endDate]"
    },
    "status": 400
}

{
    "error": {
        "code": "64338",
        "message": "invalid value: [endDate], endDate must be within 31 days"
    },
    "status": 400
}

401

{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}

403

{
    "error": {
        "code": "63001",
        "message": "No Brand Permission"
    },
    "status": 403
}

error code는 RCS Biz Center - Response body error code 참조