필터 데이터 엔드포인트

필터 데이터 엔드포인트를 사용하면 유효한 지표 목록을 조회할 수 있습니다. 이러한 지표를 사용하여 리포트 서비스 API에서 다른 엔드포인트에 대한 콜을 필터링할 수 있습니다.

전체 지표 목록은 Datascape 지표 용어집을 참고하시기 바랍니다.

시작에 앞서

엔드포인트를 사용하려면 Adjust API 토큰이 필요합니다. 인증 가이드 내 설명을 참조하여 토큰을 생성하시기 바랍니다.

엔드포인트

GET https://automate.adjust.com/reports-service/filters_data

GET request

필터 아이템 목록을 반환합니다. 반환된 객체의 id 필드를 사용하여 기타 API 콜을 필터링하시기 바랍니다.

파라미터

파라미터	데이터 유형	In	설명
`required_filters`*	`String`	Query	쉼표로 구분된 필터 목록. 아래의 필수 필터 표에서 값 목록을 확인하시기 바랍니다.
`section`	`Enum<string>`	Query	아이템을 필터링하고자 하는 섹션. 아래의 섹션 표에서 값 목록을 확인하시기 바랍니다.
`[required_filters]__contains`	`String`	Query	검색어를 입력하여 객체의 ID와 이름 필드에서 전부 일치 또는 부분 일치 결과를 찾을 수 있습니다.

필수 입력 필터

필터	설명
`apps`	앱의 목록을 반환합니다.
`apps_network`	앱의 목록과 관련된 스토어 ID를 반환합니다.
`overview_metrics`	개요 지표의 목록을 반환합니다.
`skad_metrics`	SKAdNetwork와 관련된 지표 목록을 반환합니다.
`cohort_maturity`	코호트의 완전성과 관련된 지표 목록을 반환합니다. 예: mature, immature.
`cohort_metrics`	코호트와 관련된 지표의 목록을 반환합니다.
`event_metrics`	이벤트와 관련된 지표 목록을 반환합니다. 이벤트별로 모든 지표가 동일하게 적용됩니다.
`cost_metrics`	비용과 관련된 지표 목록을 반환합니다.
`etl_metrics`	Adjust와 기타 시스템 간의 ETL(추출, 변환, 로딩)과 관련된 지표 목록을 반환합니다.
`dimensions`	항목 목록을 반환합니다.
`countries`	국가 목록을 반환합니다.
`currencies`	통화 목록을 반환합니다.
`os_names`	운영 체제 이름 목록을 반환합니다.
`networks`	네트워크 목록을 반환합니다.
`partners`	파트너 목록을 반환합니다.
`ad_revenue_sources`	광고 매출 소스 목록을 반환합니다.
`iap_revenue_mode`	광고 매출 모드 목록을 반환합니다.
`attribution_type`	어트리뷰션 유형 목록을 반환합니다. 예: all, click, impression.
`attribution_source`	어트리뷰션 소스 목록을 반환합니다.
`attribution_status`	어트리뷰션 상태 목록을 반환합니다.
`ad_spend_mode`	비용 모드 목록을 반환합니다. 예: attribution, network, mixed.
`ad_spend_mode`	광고 비용 모드의 목록을 반환합니다. 예: `attribution`, `network`, `mixed`.
`utc_offset`	UTC로부터의 오프셋(시간 단위). 기본값은 0(UTC)입니다.
`attributes`	어트리뷰션 목록을 반환합니다.
`index`	모든 앱에 관련된 주요 지표의 목록을 반환합니다.
`period_over_period`	데이터 비교에 사용된 타임존의 목록을 반환합니다.
`cohort_metric_names`	코호트 지표에 대해 읽기 가능한 이름의 목록을 반환합니다.
`full_cohort_periods`	코호트와 관련된 기간의 목록을 반환합니다.
`store_type`	앱 스토어의 목록을 반환합니다.
`skad_time_adjustment`	유효한 SKAdNetwork 활동 윈도우의 목록을 반환합니다.

섹션

섹션	설명
`conversion`	클릭 및 노출 전환 관련 지표.
`fraud`	광고 해킹 예방(fraud prevention) 관련 지표.
`cost`	비용 관련 지표.
`revenue`	앱 매출 관련 지표.
`retention`	코호트 기반 사용자 유지율 관련 지표.
`events`	이벤트 관련 지표.
`conversion_events`	SKAdNetwork 전환 이벤트 관련 지표.
`installs`	앱 설치 및 재설치 관련 지표.
`conversion_values`	SKAdNetwork 전환값 관련 지표.

응답

본 엔드포인트는 다음의 응답을 반환합니다.

응답	메세지	참고 사항
`200`	`Success`	리포트 정보 반환
`204`	`No content`	응답 객체가 공란일 경우 반환됨
`400`	`Bad request`	요청 형식이 잘못되었거나 지원되지 않는 파라미터가 포함된 경우 반환됨
`401`	`Unauthorized`	자격 증명이 올바르지 않거나 없는 경우 반환됨
`403`	`Forbidden`	열람 권한이 없는 정보에 액세스를 시도할 경우 반환됨
`429`	`Too many requests`	동시 요청이 50개를 초과하면 반환됨
`503`	`Service unavailable`	서버에 연결할 수 없는 경우 반환됨
`504`	`Gateway timeout`	쿼리의 응답 반환 시간이 너무 오래 걸리는 경우 반환됨

성공적인 응답

{
   "required_filters_1": [
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string"
      }
   ],
   "required_filters_2": [
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string"
      },
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string"
      }
   ]
}

파라미터

파라미터	데이터 유형	설명
`id`	`String`	필터 아이템의 ID. 이를 사용하여 API 콜을 필터링할 수 있습니다.
`name`	`String`	필터 아이템의 읽기 가능한 이름.
`short_name`	`String`	필터 아이템의 축약된 이름.
`section`	`String`	필터 아이템과 관련된 섹션.
`formatting`	`String`	필터 아이템의 데이터 형식. 예: `money`, `decimal`, `string`.

예시

curl --location --request GET 'https://automate.adjust.com/reports-service/filters_data?required_filters=overview_metrics,cost_metrics&section=cost&overview_metrics__contains=ecpi&cost_metrics__contains=Ad spend' \
--header 'Authorization: Bearer {API_TOKEN}'

{
   "overview_metrics": [
      {
         "id": "ecpi_all",
         "name": "eCPI (All Installs)",
         "short_name": "eCPI (All)",
         "section": "Cost",
         "formatting": "money"
      },
      {
         "id": "ecpi",
         "name": "eCPI (Paid Installs)",
         "short_name": "eCPI (Paid)",
         "section": "Cost",
         "formatting": "money"
      }
   ],
   "cost_metrics": [
      {
         "id": "network_cost",
         "name": "Ad Spend (Network)",
         "short_name": "",
         "section": "Cost",
         "formatting": "decimal"
      },
      {
         "id": "network_cost_diff",
         "name": "Ad Spend Diff (Network)",
         "short_name": "",
         "section": "Cost",
         "formatting": "decimal"
      }
   ]
}