openAPIpxmContent Scoring

Content Scoring

Content Scoring 데이터를 가져오기 위한 API입니다.

Authentication

API에 접근하기 위해 API Key가 필합니다. 예시:

curl -X GET https://app-api.commerceos.ai/open/v1/pxm/content-scoring \
     -H "x-api-key: YOUR_API_KEY"

Endpoints

Get User

Endpoint: GET /open/v1/pxm/content-scoring

Request

FieldTypeRequiredDescription
x-api-key (Header)stringYes사용자별 API Key.
startDate (Body)LocalDateYes검색할 Posting의 시작 날짜입니다.
endDate (Body)LocalDateYes검색할 Posting의 마지막 날짜입니다.

Example Request

curl -X GET https://app-api.commerceos.ai/open/v1/pxm/content-scoring?startDate=2024-01-01&endDate=2024-11-27 \
     -H "x-api-key: YOUR_API_KEY"

Response

FieldTypeRequiredDescription
startDateLocalDateTimeYes조회 기간의 시작 날짜입니다. ISO 8601 형식(YYYY-MM-DD)으로 제공됩니다.
endDateLocalDateTimeYes조회 기간의 종료 날짜입니다. ISO 8601 형식(YYYY-MM-DD)으로 제공됩니다.
resultarray ContentScoringResultYesContentScoringResult 객체의 배열입니다.
  • ContentScoringResult
FieldTypeRequiredDescription
idnumberYes고유 ID입니다.
collectTimestringYes데이터를 수집한 날짜와 시간입니다. ISO 8601 형식으로 제공됩니다.
seriesstringYesContent Scoring에 사용된 데이터 타입입니다.
platformstringYes원본 데이터의 플랫폼 이름입니다.
aliasstringYes원본 데이터의 플랫폼의 alias 입니다. (ex. retailer_id)
regionstringYes게시물이 작성된 지역입니다. 예: N.Am.
countrystringYes게시물이 작성된 국가입니다.
codestringYesScoring Check List의 Code입니다.
passbooleanYesCheck List의 Pass 여부입니다.
reasonstringYespass의 판별 이유입니다.
reasonSourcestringYesCheck List를 판별하기 위해 사용한 데이터입니다.
reasonSourceTypestringYesreasonSource의 Type입니다. (imageUrl, imageUrls, text)
  • Status: 200 OK
  • Body:
{
}