API Hop 문서
Similarweb API 참조
Similarweb 엔드포인트의 쿼리 매개변수, 기본값 및 기본 응답 형식입니다.
아래의 모든 경로는 API 원본 주소를 기준으로 합니다. 모든 요청에는 Authorization: Bearer YOUR_API_KEY가 필요하며 GET을 사용하고 요청 본문은 없습니다. 인증, 과금 및 오류를 참고하세요.
쿼리 규칙
단일 웹사이트 필드인 key와 Key에는 amazon.com과 같은 ASCII 도메인 하나가 필요합니다. 최대 253자이며 앞뒤 공백이 없어야 합니다. 이 필드에 URL, IP 주소, 도메인 목록 또는 API 인증 정보를 보내지 마세요. 국제화 도메인에는 punycode를 사용하세요.
쿼리 이름은 대소문자를 구분합니다. 알 수 없는 필드, 중복 필드, CR/LF/NUL 및 잘못된 값은 거부됩니다. 불리언 값은 리터럴 true 또는 false이며, 0을 false 대신 사용할 수 없습니다. 텍스트는 앞뒤 공백을 제거한 후 UTF-8 기준 1-2048바이트여야 합니다. 공백, JSON 배열 및 구분자는 HTTP 클라이언트의 쿼리 인코더로 인코딩하세요.
from과 to는 함께 있어야 하며 YYYY-MM-DD 또는 YYYY|MM|DD 형식의 실제 달력 날짜이고 from <= to를 충족해야 합니다. 비교 날짜 쌍에도 같은 규칙이 적용됩니다. 선택 필드는 엔드포인트 기본값을 상속합니다. 표는 허용 필드를 나열하며 모든 필드를 보내야 한다는 뜻은 아닙니다.
날짜를 허용하는 엔드포인트에서는 유효하고 완전한 명시적 from/to 범위가 우선합니다. latest를 허용하는 엔드포인트에서는 입력값에 기존 형식 및 엔드포인트별 검증을 적용하지만, 범위 선택에는 사용하지 않고 Similarweb에도 보내지 않으며 기본 latest도 추가하지 않습니다. 명시적 범위가 없으면 기존 latest, 기본값 및 기간 동작은 그대로 유지됩니다. History 제한은 계속 적용되며 latest를 허용하지 않는 엔드포인트는 여전히 해당 필드를 거부합니다.
명시적 from/to 범위가 없는 경우: 기간 기반 경로는 보통 UTC 기준 3일 전에 끝나는 28일 구간을 기본으로 하며 latest=1d부터 366d까지 허용합니다. 고정 월 경로의 기본값은 아래에 표시되어 있습니다. 참여도, 방문, 순위 및 채널은 이전의 완전한 UTC 달력 월을 나타내는 latest=1m|2m|3m|6m도 허용합니다. 이 선택자는 isWindow=false가 필요하며 기본값은 timeGranularity=Monthly입니다. 기록 데이터에는 해당 4개 엔드포인트에 명시된 더 좁은 규칙이 적용됩니다.
전 세계 데이터(country=999)만 지원합니다. 웹사이트 식별자는 example.com 같은 도메인입니다. 단, 키워드 순위 엔드포인트에서 keys는 검색 키워드입니다. 상위 소스의 데이터 가용성, 필터 및 일치 유형은 달라질 수 있습니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다.
성공 응답은 공통 응답 스키마로 변환하지 않고 기본 JSON을 유지합니다. 유입 및 유출 추천 표는 Records를 사용하며 과거 지표는 중첩된 Data를 사용할 수 있습니다. 아래에 설명된 이름과 단위는 상위 소스의 모든 선택 필드가 항상 존재한다는 뜻이 아닙니다.
엔드포인트
키워드 제안
GET https://api.apihop.ai/v1/similarweb/keywords/suggestions
기본값: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total 및 windowVolume 내림차순. 선택 항목 page는 1부터 시작합니다. rangeFilter는 volume,100,10000|difficulty,0,40 같은 기본 구문을 사용합니다. 일치 유형과 필터의 가용성은 데이터 소스에 따라 다릅니다. 전 세계 데이터(country=999)만 지원합니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keyword | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
sort | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
asc | 아니요 | 불리언 문자열: true 또는 false |
page | 아니요 | 정수 문자열; 1-1000 |
rowsPerPage | 아니요 | 정수 문자열; 1-1000 |
type | 아니요 | 문자열; 허용값: Broad, Phrase, Exact, Related |
websource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
rangeFilter | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
백링크
GET https://api.apihop.ai/v1/similarweb/websites/backlinks
기본값: Page 1, PageSize 100, Status All, FollowType All 및 DomainScore 내림차순. Key는 대문자로 시작합니다. key나 keys를 사용하지 마세요.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
Key | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
Page | 아니요 | 정수 문자열; 1-1000 |
PageSize | 아니요 | 정수 문자열; 1-1000 |
Status | 아니요 | 문자열; 허용값: All, Active, New, Lost |
FollowType | 아니요 | 문자열; 허용값: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
DomainScoreFrom | 아니요 | 정수 문자열; 0-100 |
DomainScoreTo | 아니요 | 정수 문자열; 0-100 |
sort | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
asc | 아니요 | 불리언 문자열: true 또는 false |
웹사이트 키워드
GET https://api.apihop.ai/v1/similarweb/websites/keywords
기본값: page 1, pageSize 100, sourceType all 및 두 브랜드 플래그 모두 false. pageFilterJson은 URL로 인코딩된 JSON 배열 문자열 하나입니다. 생략하면 keys를 도메인으로 사용합니다. 명시적 from/to 범위가 없는 경우: latest=1m은 명시적으로 지정하지 않는 한 pageSize 5와 isWindow=false인 1개월 개요 모드를 선택합니다. 비브랜드 키워드 보기는 sourceType=organic 또는 paid와 IncludeNoneBranded=true, IncludeBranded=false를 사용하세요.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
sort | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
asc | 아니요 | 불리언 문자열: true 또는 false |
iso | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
isDaily | 아니요 | 불리언 문자열: true 또는 false |
IncludeBranded | 아니요 | 불리언 문자열: true 또는 false |
IncludeNoneBranded | 아니요 | 불리언 문자열: true 또는 false |
page | 아니요 | 정수 문자열; 1-1000 |
pageSize | 아니요 | 정수 문자열; 1-1000 |
sourceType | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
pageFilterJson | 아니요 | JSON 배열을 포함한 문자열 |
키워드 순위에 있는 웹사이트
GET https://api.apihop.ai/v1/similarweb/keywords/websites
keys는 웹사이트 도메인이 아니라 키워드입니다. 기본값은 selectedPageTab=Organic, sourceType=organic, Device=Total, graphDuration=28d를 포함합니다. 선택 항목 page는 1부터 시작하며 pageSize는 양의 정수입니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
sort | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
asc | 아니요 | 불리언 문자열: true 또는 false |
iso | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
isDaily | 아니요 | 불리언 문자열: true 또는 false |
tab | 아니요 | 음이 아닌 정수 문자열 |
mtd | 아니요 | 불리언 문자열: true 또는 false |
selectedPageTab | 아니요 | 문자열; 허용값: Organic, Paid |
graphDuration | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
graphType | 아니요 | 정수 문자열; 1-1000 |
isDurationChanged | 아니요 | 불리언 문자열: true 또는 false |
ignoreFilterConsistency | 아니요 | 불리언 문자열: true 또는 false |
Device | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
sourceType | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
page | 아니요 | 정수 문자열; 1-1000 |
pageSize | 아니요 | 정수 문자열; 1-1000 |
트래픽 소스
GET https://api.apihop.ai/v1/similarweb/websites/traffic-sources
기본값: sourceType=Referral, page=1, orderBy=Share desc 및 timeGranularity=Daily. 이 표는 유입 추천 엔드포인트와 별개입니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
sourceType | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
ignoreFilterConsistency | 아니요 | 불리언 문자열: true 또는 false |
page | 아니요 | 정수 문자열; 1-1000 |
orderBy | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
유출 트래픽
GET https://api.apihop.ai/v1/similarweb/websites/outgoing-traffic
from과 to는 필수입니다. 단일 key만 사용합니다. 기본값: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby와 orderBy는 서로 다르며 독립적으로 전달되므로 일관되게 설정하세요. latest, pageSize, rowsPerPage, includeSubDomains 또는 timeGranularity는 허용되지 않습니다. 행은 Records에 있으며 TotalCount는 현재 페이지 길이가 아니라 상위 소스의 전체 개수입니다. 전 세계 데이터(country=999)만 지원합니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
key | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 예 | 문자열; 위 형식의 유효한 날짜 |
to | 예 | 문자열; 위 형식의 유효한 날짜 |
isWWW | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
orderby | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
orderBy | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
sort | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
asc | 아니요 | 불리언 문자열: true 또는 false |
page | 아니요 | 정수 문자열; 1-1000 |
유입 추천
GET https://api.apihop.ai/v1/similarweb/websites/incoming-referrals
단일 key만 사용합니다. 기본값: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. keys, pageSize, rowsPerPage, includeSubDomains 또는 timeGranularity는 허용되지 않습니다. 행은 Records에 있으며 기본 필드에 SiteOrigins와 TotalShare가 포함될 수 있습니다. 전 세계 데이터(country=999)만 지원합니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
key | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
isWWW | 아니요 | 불리언 문자열: true 또는 false |
iso | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
isDaily | 아니요 | 불리언 문자열: true 또는 false |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
selectedTab | 아니요 | 문자열; 허용값: incomingTraffic |
orderBy | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
ignoreFilterConsistency | 아니요 | 불리언 문자열: true 또는 false |
page | 아니요 | 정수 문자열; 1-1000 |
브랜드 키워드 비중
GET https://api.apihop.ai/v1/similarweb/websites/branded-keywords
기본값은 이전의 완전한 UTC 1개월입니다. duration은 1m으로 고정됩니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
duration | 아니요 | 문자열; 허용값: 1m |
트래픽 지역 분포
GET https://api.apihop.ai/v1/similarweb/websites/geography
기본값은 이전의 완전한 UTC 3개월, pageSize=5 및 orderBy=TotalShare desc입니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
pageSize | 아니요 | 정수 문자열; 1-1000 |
orderBy | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
기기 분포
GET https://api.apihop.ai/v1/similarweb/websites/devices
기본값은 이전의 완전한 UTC 3개월 및 ShouldGetVerifiedData=false입니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
ShouldGetVerifiedData | 아니요 | 불리언 문자열: true 또는 false |
검색 성과
GET https://api.apihop.ai/v1/similarweb/websites/search-performance
기본값은 이전의 완전한 UTC 1개월, pageSize=5, duration=1m 및 SourceType=Organic입니다. 유료 키워드에는 SourceType=Paid를 사용하고 sourceType으로 대체하지 마세요.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
pageSize | 아니요 | 정수 문자열; 1-1000 |
duration | 아니요 | 문자열; 허용값: 1m |
SourceType | 아니요 | 문자열; 허용값: Organic, Paid |
소셜 트래픽
GET https://api.apihop.ai/v1/similarweb/websites/social-traffic
기본값은 이전의 완전한 UTC 3개월입니다. webSource는 허용되지 않습니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
참여도 개요
GET https://api.apihop.ai/v1/similarweb/websites/engagement
기본값은 ShouldGetVerifiedData=false, includeLeaders=true 및 unBounced=false를 포함합니다. 기본 Data 행에 AvgMonthVisits, BounceRate, PagesPerVisit 및 AvgVisitDuration이 포함될 수 있습니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
ShouldGetVerifiedData | 아니요 | 불리언 문자열: true 또는 false |
includeLeaders | 아니요 | 불리언 문자열: true 또는 false |
unBounced | 아니요 | 불리언 문자열: true 또는 false |
beta | 아니요 | 불리언 문자열: true 또는 false |
총방문 수
GET https://api.apihop.ai/v1/similarweb/websites/visits
compareFrom과 compareTo는 순서가 올바른 유효한 날짜로 함께 제공해야 합니다. timeGranularity는 Monthly입니다. 기본 필드에 TotalVisits, Change 및 ShareOfVisits가 포함될 수 있습니다. 이동 합계가 반드시 완전한 달력 월의 합계인 것은 아닙니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
compareFrom | 아니요 | 문자열; 위 형식의 유효한 날짜 |
compareTo | 아니요 | 문자열; 위 형식의 유효한 날짜 |
ShouldGetVerifiedData | 아니요 | 불리언 문자열: true 또는 false |
방문 표
GET https://api.apihop.ai/v1/similarweb/websites/visits/table
compareFrom과 compareTo는 순서가 올바른 유효한 날짜로 함께 제공해야 합니다. timeGranularity는 Monthly이며 행은 Domain과 TotalVisits를 포함한 Data에 있습니다. Data에 행이 있어도 TotalCount는 0일 수 있습니다. 결과가 있는지 확인하려면 배열 자체를 검사하세요.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
compareFrom | 아니요 | 문자열; 위 형식의 유효한 날짜 |
compareTo | 아니요 | 문자열; 위 형식의 유효한 날짜 |
ShouldGetVerifiedData | 아니요 | 불리언 문자열: true 또는 false |
방문 추세
GET https://api.apihop.ai/v1/similarweb/websites/visits/trend
기본값은 일별 데이터를 사용하는 이동식 28일 구간입니다. timeGranularity는 Daily, Weekly 또는 Monthly를 허용합니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Weekly, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
ShouldGetVerifiedData | 아니요 | 불리언 문자열: true 또는 false |
웹사이트 순위
GET https://api.apihop.ai/v1/similarweb/websites/ranks
timeGranularity는 Monthly입니다. 기본 응답은 서로 다른 GlobalRank, CountryRank 및 CategoryRank 객체를 사용합니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
국가 순위
GET https://api.apihop.ai/v1/similarweb/websites/ranks/country
timeGranularity는 Monthly입니다. 통합 순위 응답이 아니라 명시적인 국가 순위 표입니다. 행은 Domain과 Rank를 포함한 Data에 있습니다. 행이 있어도 TotalCount는 0일 수 있으므로 Data를 직접 검사하세요.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
세계 순위
GET https://api.apihop.ai/v1/similarweb/websites/ranks/global
timeGranularity는 Monthly입니다. 별도의 세계 순위 표를 반환합니다. 행은 Domain과 Rank를 포함한 Data에 있습니다. 행이 있어도 TotalCount는 0일 수 있으므로 Data를 직접 검사하세요.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
카테고리 순위
GET https://api.apihop.ai/v1/similarweb/websites/ranks/category
timeGranularity는 Monthly입니다. 별도의 업종/카테고리 순위 표를 반환합니다. 행은 Domain과 Rank를 포함한 Data에 있습니다. 행이 있어도 TotalCount는 0일 수 있으므로 Data를 직접 검사하세요.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
트래픽 채널
GET https://api.apihop.ai/v1/similarweb/websites/channels
기본값은 일별 데이터를 사용하는 이동식 28일 구간입니다. webSource=Total이면 채널 값은 Data[domain] 바로 아래가 아니라 Data.Total[domain] 아래에 있습니다. Search - Organic, Direct 같은 채널 이름은 그대로 유지됩니다. 값은 방문 횟수이며 합계가 양수일 때만 비중을 계산하세요.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Daily, Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
유사 사이트
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites
기본값은 이전의 완전한 UTC 3개월입니다. isWindow는 false여야 하고 timeGranularity는 Monthly이며 orderBy는 Affinity desc로 고정됩니다. latest 또는 webSource는 허용되지 않습니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
orderBy | 아니요 | 문자열; 허용값: Affinity desc |
유사 사이트 제안
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions
단일 key를 사용합니다. limit 기본값은 20이며 1-20이어야 합니다. country 기본값은 999, webSource 기본값은 Total입니다. 관찰된 기본 응답은 Domain, DomainWithoutSub, 숫자형 Rank 및 Favicon을 포함한 래퍼 없는 후보 배열입니다. Data 래퍼를 기대하지 마세요. 빈 배열에는 제안이 없습니다. 전 세계 데이터(country=999)만 지원합니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
key | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
limit | 아니요 | 정수 문자열; 1-20 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
월별 방문 기록
GET https://api.apihop.ai/v1/similarweb/websites/history/visits
기본값은 이전의 완전한 UTC 6개월입니다. country=999, isWindow=false, timeGranularity=Monthly만 지원합니다. latest는 1m부터 6m까지 허용하며, 명시적 날짜는 이 이동식 6개월 구간 안의 완전한 월이어야 합니다. 기본 시계열은 Key/Value 지점과 함께 Data.<domain>.<source> 아래에 나타날 수 있으며, MobileWeb 또는 Mobile Web을 포함한 소스 이름은 그대로 유지됩니다. 값은 추정 방문 수를 나타냅니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
월별 이탈률 기록
GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate
기본값은 이전의 완전한 UTC 6개월입니다. country=999, isWindow=false, timeGranularity=Monthly만 지원합니다. latest는 1m부터 6m까지 허용하며, 명시적 날짜는 이 이동식 6개월 구간 안의 완전한 월이어야 합니다. 기본 시계열은 Key/Value 지점과 함께 Data.<domain>.<source> 아래에 나타날 수 있으며, MobileWeb 또는 Mobile Web을 포함한 소스 이름은 그대로 유지됩니다. 값은 이탈률의 소수 비율을 나타냅니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
월별 방문 시간 기록
GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration
기본값은 이전의 완전한 UTC 6개월입니다. country=999, isWindow=false, timeGranularity=Monthly만 지원합니다. latest는 1m부터 6m까지 허용하며, 명시적 날짜는 이 이동식 6개월 구간 안의 완전한 월이어야 합니다. 기본 시계열은 Key/Value 지점과 함께 Data.<domain>.<source> 아래에 나타날 수 있으며, MobileWeb 또는 Mobile Web을 포함한 소스 이름은 그대로 유지됩니다. 값은 방문당 초를 나타냅니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
월별 방문당 페이지 기록
GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit
기본값은 이전의 완전한 UTC 6개월입니다. country=999, isWindow=false, timeGranularity=Monthly만 지원합니다. latest는 1m부터 6m까지 허용하며, 명시적 날짜는 이 이동식 6개월 구간 안의 완전한 월이어야 합니다. 기본 시계열은 Key/Value 지점과 함께 Data.<domain>.<source> 아래에 나타날 수 있으며, MobileWeb 또는 Mobile Web을 포함한 소스 이름은 그대로 유지됩니다. 값은 방문당 페이지 수를 나타냅니다.
| 쿼리 필드 | 필수 여부 | 유형 및 제약 조건 |
|---|---|---|
keys | 예 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |
country | 아니요 | 음이 아닌 정수 문자열; 전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다. |
from | 아니요 | 문자열; 위 형식의 유효한 날짜 |
to | 아니요 | 문자열; 위 형식의 유효한 날짜 |
includeSubDomains | 아니요 | 불리언 문자열: true 또는 false |
isWindow | 아니요 | 불리언 문자열: true 또는 false |
webSource | 아니요 | 문자열; 허용값: Total, Desktop, MobileWeb |
timeGranularity | 아니요 | 문자열; 허용값: Monthly |
latest | 아니요 | 문자열; 앞뒤 공백 제거 후 UTF-8 기준 1-2048바이트 |