브랜드 슬라이드 소식 상세 통계

Request

지정된 브랜드의 슬라이드 소식 상세 통계를 조회 합니다.

get

지정된 브랜드의 슬라이드 소식 상세 통계를 조회 합니다. Slide유형은 gallery, share 유형으로 구성되므로 type query parameter 지정 조회 시 참고하시기 바랍니다.

Authorizations

Path parameters

brandIdstringRequired

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

Query parameters

offsetintegerOptional

시작 offset 번호(default: 0) 입니다.

limitintegerOptional

maxLength: 100 - 조회 최대 건수(default: 10, maxLength: 100) 입니다.

typestring · enumOptional

소식 유형을 지정합니다.

Possible values:

startDatestringOptional

maxLength: 8 - 검색 시작일자(YYYYMMDD)를 지정합니다. 미지정 시 현재일 기준 전일로 부터 30일 이전 일자 기본 설정되며, 검색 시작일과 종료일의 범위는 최대 1개월입니다. 검색 가능 일자 범위는 전일 기준 1년 이내 입니다.

endDatestringOptional

maxLength: 8 - 검색 종료일자(YYYYMMDD)를 지정합니다. 미지정 시 현재일 기준 전일로 기본 설정되며, 검색 시작일과 종료일의 범위는 최대 1개월입니다. 검색 가능 일자 범위는 전일 기준 1년 이내 입니다.

Header parameters

X-RCS-BrandkeystringOptional

maxLength: 36 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다. 대행사가 브랜드 소식 API 연동 시 Header에 반드시 설정하여야 합니다.

get

HTTPcURLJavaScriptPython

GET /bfapi/1.0/brand/{brandId}/feed/stat/slide HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<FeedSlideStat>		O		브랜드 소식의 슬라이드 상세 통계
code	string	5	O	20000000	리턴코드값
status	integer	3	O	200	상태값
desc	string		O		처리메시지
pagination	Pagination		O		전체건수와 페이징조건
links	Links		O		이전/다음

result - array<FeedSlideStat>

필드명	타입	길이	필수여부	기본값	설명
brandId	string	13			브랜드 ID
feedId	string	10			소식 ID
ymd	string	10			통계일자
title	string	8			소식 제목
orderNo	integer				슬라이드 정렬 순번
slideType	integer				슬라이드 소식 내 유형 gallery, share
btn1ClCnt	integer				당일 버튼1 클릭수
btn1ClTotCnt	integer				누적 버튼1 클릭수
btn2ClCnt	integer				당일 버튼2 클릭수
btn2ClTotCnt	integer				누적 버튼2 클릭수

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": {
        "statList": [
            {
                "brandId": "BR.mp0Xf8sGBE",
                "feedId": "BR.mp0Xf8sGBE.9Gl7EXeg69",
                "ymd": "2024-07-04",
                "title": "써 본 사람은 아는 LG 건조기 이야기",
                "ordNo": 1,
                "slideType": "share",
                "btn1ClCnt": 2,
                "btn1ClTotCnt": 188,
                "btn2ClCnt": 0,
                "btn2ClTotCnt": 0
            },
            {
                "brandId": "BR.mp0Xf8sGBE",
                "feedId": "BR.mp0Xf8sGBE.9Gl7EXeg69",
                "ymd": "2024-07-03",
                "title": "써 본 사람은 아는 LG 건조기 이야기",
                "ordNo": 1,
                "slideType": "share",
                "btn1ClCnt": 3,
                "btn1ClTotCnt": 186,
                "btn2ClCnt": 0,
                "btn2ClTotCnt": 0
            },
            {
                "brandId": "BR.mp0Xf8sGBE",
                "feedId": "BR.mp0Xf8sGBE.9Gl7EXeg69",
                "ymd": "2024-07-02",
                "title": "써 본 사람은 아는 LG 식기세척기 이야기",
                "ordNo": 2,
                "slideType": "share",
                "btn1ClCnt": 0,
                "btn1ClTotCnt": 0,
                "btn2ClCnt": 2,
                "btn2ClTotCnt": 15
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 3
    },
    "links": {
        "prev": null,
        "next": null
    },
    "status": 200
}

401

{
  "status": "401",
  "error": {
    "code": "61001",
    "message": "Missing Authorization header"
  }
}

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

{
    "error": {
        "code": "64713",
        "message": "No File Permission [BR.Q63creSjku-FDRwSMvksa5P]"
    },
    "status": 401
}

error code는 브랜드소식 - Response body error code 참조