Content Scoring

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

Authentication

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

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

Endpoints

Get User

Endpoint: GET /open/v1/pxm/v2.1/content-scoring

Request

Field	Type	Required	Description
`x-api-key` (Header)	string	Yes	사용자별 API Key.
`startDate` (Body)	LocalDate	Yes	검색할 Posting의 시작 날짜입니다.
`endDate` (Body)	LocalDate	Yes	검색할 Posting의 마지막 날짜입니다.

Example Request

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

Response

Field	Type	Required	Description
`startDate`	LocalDateTime	Yes	조회 기간의 시작 날짜입니다. ISO 8601 형식(`YYYY-MM-DD`)으로 제공됩니다.
`endDate`	LocalDateTime	Yes	조회 기간의 종료 날짜입니다. ISO 8601 형식(`YYYY-MM-DD`)으로 제공됩니다.
`result`	array `ContentScoringResult`	Yes	`ContentScoringResult` 객체의 배열입니다.

ContentScoringResult

Field	Type	Required	Description
`id`	number	Yes	고유 ID입니다.
`collectedAt`	string	Yes	데이터를 수집한 날짜와 시간입니다. 각 지역별 LocalTimed으로, ISO 8601 형식으로 제공됩니다.
`category`	string	Yes	Content Scoring에 사용된 데이터 타입입니다.
`platform`	string	Yes	원본 데이터의 플랫폼 이름입니다.
`alias`	string	Yes	원본 데이터의 플랫폼의 alias 입니다. (ex. retailer_id)
`region`	string	Yes	게시물이 작성된 지역입니다. 예: `N.Am`.
`country`	string	Yes	게시물이 작성된 국가입니다.
`device`	string	Yes	데이터가 수집된 device환경입니다.
`code`	string	Yes	Scoring Check List의 Code입니다.
`pass`	boolean	No	Check List의 Pass 여부입니다. (if null. N/A)
`reason`	string	Yes	pass의 판별 이유입니다.
`reasonSource`	string	Yes	Check List를 판별하기 위해 사용한 데이터입니다.
`reasonSourceType`	string	Yes	reasonSource의 Type입니다. (imageUrl, imageUrls, text)
`screenshot`	string	Yes	category 별 페이지의 Screenshot입니다.

ReasonSource Json Type

IncludeKeywordInTitle

Field	Type	Required	Description
`title`	string	Yes	PDP Product Title로 SEO 대상입니다.
`includeTitleKeywords`	string	Yes	타겟으로 하는 SEO 키워드 중 title내 포함 키워드입니다.
`pass`	string	Yes	includeTitleKeywords 존재 여부에 따라 Pass 여부를 제공합니다. (삭제 예정)

Array[IncludeKeywordInImageName]

Field	Type	Required	Description
`url`	string	Yes	PDP 페이지에 존재하는 제품 역영에 해당하는 모든 이미지의 URL입니다.
`includeUrlKeywords`	string	Yes	타겟으로 하는 SEO 키워드 중 URL내 포함 키워드입니다.
`pass`	string	Yes	includeUrlKeywords 존재 여부에 따라 Pass 여부를 제공합니다.

Array[IncludeKeywordInImageAlt]

Field	Type	Required	Description
`alt`	string	Yes	PDP 페이지에 존재하는 제품 역영에 해당하는 모든 이미지의 Alt 입니다.
`includeAltKeywords`	string	Yes	타겟으로 하는 SEO 키워드 중 Alt 내 포함 키워드입니다.
`pass`	string	Yes	includeAltKeywords 존재 여부에 따라 Pass 여부를 제공합니다.

IncludeKeywordInContentTexts

Field	Type	Required	Description
`contentText`	string	Yes	PDP 전체 Contents로 SEO 대상입니다.
`includeKeywords`	string	Yes	타겟으로 하는 SEO 키워드 중 title내 포함 키워드입니다.

Status: 200 OK
Body:

{
    "startDate": "2025-01-08",
    "endDate": "2025-01-08",
    "result": [
        {
            "id": "42817683036569600",
            "category": "Home",
            "platform": "1und1_de",
            "collectedAt": "2025-01-08T08:20:00",
            "alias": "1und1_de",
            "region": "Europe",
            "country": "Germany",
            "device": "PC",
            "code": "cs-sm-1",
            "codeDescription": "Lettermark is top left or top right or attached to the product logo",
            "reason": "We couldn't detect any lettermark.",
            "reasonSource": "https://www.1und1.de/_Resources/Persistent/5c750cd75b0400b844dc94f065a8faf5c83e1401/d-buehne-d32663-neo-img-1und1-unlimited-tarife-1200x650.png?bust=3|https://www.1und1.de/_Resources/Persistent/0ec08a7706cbd8474d585ef5a634ede09513232c/d-buehne-v4086-img-apple-iphone-16-serie-mit-1und1-unlimited-1200x650.png?bust=3|https://www.1und1.de/_Resources/Persistent/9d92eca9bb2d2cd9b99ef820e831547f28361cbe/d-t-bb-dsl-buehne-bg-visual-v4114-img.webp?bust=3|https://www.1und1.de/_Resources/Persistent/490e555fd4492e0bbd84171df2726f6adc13a8f6/d-t-bb-gf-buehne-visual-4114-img-haus-mit-glasfaserkabel-1200x650.webp?bust=3",
            "reasonSourceType": "ImageUrls",
            "screenshot": "https://collected-data.commerceos.ai/samsung/content_scoring/2025/01/08/08/1und1_de/PC/home.png"
        },
        {
            "id": "42817816390270976",
            "category": "Home",
            "platform": "1und1_de",
            "collectedAt": "2025-01-08T08:20:00",
            "alias": "1und1_de",
            "region": "Europe",
            "country": "Germany",
            "device": "MOBILE",
            "code": "cs-sm-1",
            "codeDescription": "Lettermark is top left or top right or attached to the product logo",
            "reason": "We couldn't detect any lettermark.",
            "reasonSource": "https://www.1und1.de/_Resources/Persistent/173c9610e3e71974c6c6b9817b93fff046579148/m-eue-buehne-v4036-img-iphone-weihnachtsaktion-neu-910x1264.png?bust=3|https://www.1und1.de/_Resources/Persistent/533d505f4277730e33cfdc4e5620d6a50f030e2f/m-bb-gf-buehne-visual-4114-img-haus-mit-glasfaserkabel-910x1264.webp?bust=3|https://www.1und1.de/_Resources/Persistent/37a4c7a0ea1687cfec5c6bb6b7449a78b4d9b130/m-buehne-v4086-neo-img-1und1-unlimited-tarifev04-910x1264.png?bust=3",
            "reasonSourceType": "ImageUrls",
            "screenshot": "https://collected-data.commerceos.ai/samsung/content_scoring/2025/01/08/08/1und1_de/MOBILE/home.png"
        }
    ]
}```

E Promoter