브랜드 소식 메인 통계

Request

지정된 브랜드의 소식 메인 통계를 조회 합니다.

get

https://api-qa.rcsbizcenter.com/bfapi/1.0https://api.rcsbizcenter.com/bfapi/1.0

/brand/{brandId}/feed/stat/main

지정된 브랜드의 소식 메인 통계를 조회 합니다.

Authorizations

jwtAuth

AuthorizationstringRequired

인증방식은 JWT인증을 사용합니다. 토큰의 갱신은 없으며 토큰 만료 시 항상 재발급 받아야 합니다.

Path parameters

brandIdstringRequired

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

Query parameters

offsetintegerOptional

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

limitintegerOptional

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

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에 반드시 설정하여야 합니다.

Responses

200

페이지 내 Response 섹션 참조

No content

get

/brand/{brandId}/feed/stat/main

HTTPcURLJavaScriptPython

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

200

페이지 내 Response 섹션 참조

No content

Response

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

result - array<BrandFeed>

필드명	타입	길이	필수여부	기본값	설명
brandId	string	13			브랜드 ID
ymd	string	8			통계일자
stayTime	string				체류시간 단위 초(sec)
pvCnt	integer				당일 페이지 뷰수
pvTotCnt	integer				누적 페이지 뷰수
clCnt	integer				당일 소식 클릭수
clTotCnt	integer				누적 소식 클릭수

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": {
        "statList": [
            {
                "brandId": "BR.dM1gH08zPw",
                "ymd": "2024-07-04",
                "stayTime": 0,
                "pvCnt": 5,
                "pvTotCnt": 1519,
                "clCnt": 0,
                "clTotCnt": 25
            },
            {
                "brandId": "BR.dM1gH08zPw",
                "ymd": "2024-07-03",
                "stayTime": 0,
                "pvCnt": 8,
                "pvTotCnt": 1514,
                "clCnt": 0,
                "clTotCnt": 25
            },
            {
                "brandId": "BR.dM1gH08zPw",
                "ymd": "2024-07-02",
                "stayTime": 0,
                "pvCnt": 15,
                "pvTotCnt": 1506,
                "clCnt": 0,
                "clTotCnt": 25
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 3
    },
    "links": {
        "prev": null,
        "next": null
    },
    "status": 200
}

401

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