Search Share

Search Share 데이터를 가져오기 위한 API입니다.

Authentication

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

curl -X GET https://app-api.commerceos.ai/open/v1/exposures/search-share \
     -H "x-api-key: YOUR_API_KEY"

Endpoints

Get User

Endpoint: GET /open/v1/exposures/search-share

Request

Field	Type	Required	Description
`x-api-key` (Header)	string	Yes	사용자별 API Key.
`startDate` (Body)	LocalDate	Yes	검색할 Posting의 시작 날짜입니다.
`endDate` (Body)	LocalDate	Yes	검색할 Posting의 마지막 날짜입니다.
`dateType` (Body)	string	No	enum(CollectedAt, PostedAt) 검색 기준을 설정합니다. (Default. PostedAt)

Example Request

curl -X GET https://app-api.commerceos.ai/open/v1/exposures/search-share?maxProductSize=1&startDate=2025-01-22&endDate=2025-01-22&dateType=CollectedAt \
     -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 `SearchShareResult`	Yes	`SearchShareResult` 객체의 배열입니다.

SearchShareResult

Field	Type	Required	Description
`id`	number	Yes	고유 ID입니다.
`collectTime`	string	Yes	데이터를 수집한 날짜와 시간입니다. ISO 8601 형식으로 제공됩니다.
`alias`	string	Yes	각 플랫폼별 alias 식별자입니다. (ex. retailer_id)
`keyword`	string	Yes	Search 에서 사용된 키워드입니다.
`device`	string	Yes	수집 device입니다.
`screenshotUrl`	string	Yes	프로덕트 검색 화면에 대한 Screenshot 이미지입니다.
`bannerAdImageUrl`	string	Yes	프로덕트 검색 화면시 표기된 광고 배너 이미지입니다. (Sponsored Brand)
`bannerAdBrand`	string	Yes	프로덕트 검색 화면시 표기된 광고 배너의 브랜드입니다.
`products`	array `SearchShareProduct`	Yes	검색된 프로덕트 리스트 정보입니다.

SearchShareProduct

Field	Type	Required	Description
`totalIndex`	number	Yes	전체 제품 기준 index입니다.
`productIndex`	string	Yes	검색된 제품 기준 index입니다.
`name`	string	Yes	검색 결과 Title / Name입니다.
`price`	string	Yes	검색 결과 제품의 가격 정보입니다.
`rating`	string	Yes	검색 결과 제품의 rating 입니다. 수집 불가시 text로 null이 기입됩니다.
`isSponsored`	boolean	yes	sponsored 제품인지에 대한 여부입니다.
`brandName`	string	Yes	검색 결과 제품의 브랜드입니다.
`productName`	string	Yes	검색 결과 제품명입니다.
`platformIdentifierNumber`	string	false	플랫폼별 각 제품의 고유 식별자입니다. (ex. ASIN)
`url`	string	false	검색된 제품의 다이렉트 URL입니다.

Status: 200 OK
Body:

{
    "aliases": [],
    "startDate": "2025-01-22",
    "endDate": "2025-01-22",
    "result": [
        {
            "id": "48095688063451136",
            "collectTime": "2025-01-22T21:15:31",
            "alias": "pureplayer_na_seca_canada_amazon",
            "keyword": "AI_Translator",
            "device": "MOBILE",
            "screenshotUrl": "https://collected-data.commerceos.ai/samsung/2025/01/22/21/amazon_ca/MOBILE/AI_Translator.png",
            "bannerAdImageUrl": "https://collected-data.commerceos.ai/samsung/2025/01/22/21/amazon_ca/MOBILE/AI_Translator_banner1.png",
            "bannerAdBrand": "Other",
            "products": [
                {
                    "totalIndex": "1",
                    "productIndex": "1",
                    "name": "Language Translator Device, VORMOR ChatGpt AI Translator, Two Way Real-Time Voice Spainish English Translation, Support 138 Languages, Offline&Recording&Photo Translation for Travel Business Learning",
                    "price": "$99.99",
                    "rating": "4.1",
                    "isSponsored": true,
                    "brandName": "Other",
                    "productName": "Etc",
                    "platformIdentifierNumber": "B0DQ1454HC",
                    "url": "https://www.amazon.ca/dp/B0DQ1454HC"
                }
            ]
        }
    ]
 }

Pr Monitoring Social Posting