일반 정보

인증

모든 API 요청에는 API 키가 필요합니다. 키를 검색하려면 계정에 로그인하고 개발자 도구 > API 키로 이동하세요. 요청의 api_key 매개변수에 키를 삽입하거나 인증 HTTP 헤더 아래에 토큰을 제공할 수 있습니다.

요금 한도

단수 API의 기본 한도는 다음과 같습니다:

• 비동기 보고서: 최대 100개의 비동기 보고서가 동시에 실행됩니다.
• 동기 보고서: 최대 3개의 동기 보고서가 동시에 실행됩니다.
• 단일 보고서 행 제한: 쿼리당 최대 20만 개의 행.
• 일일 글로벌 행 제한: 하루에 최대 3백만 개의 행(모든 쿼리에서 공유).

Singular는 모든 고객에게 고품질의 서비스를 지속적으로 제공하기 위해 특정 엔드포인트에 대한 속도 제한을 조정할 수 있는 권리를 보유합니다. 기본 한도를 초과해야 하는 특별한 필요성이 있는 경우 당사에 문의하세요.

신고 API 엔드포인트 목록

다음 API 엔드포인트를 사용할 수 있습니다:

비동기 보고서 엔드포인트 만들기

import requests
  url = "https://api.singular.net/api/v2.0/create_async_report"
  query_params = {"api_key": "<API KEY>"}
  payload = {
    "dimensions":"app,source,os,country_field",
    "metrics": "custom_impressions,custom_clicks,custom_installs",
    "start_date":"2020-01-01",
    "end_date": "2020-01-01",
    "time_breakdown": "all",
    "format": "csv",
    "country_code_format": "iso"
  }
  response = requests.post(url=url, params=query_params, data=payload)
  print(response.text)

{
      "status": 0,
      "substatus": 0,
      "value": {
          "report_id": "5cfdb747dd464cd09a9c463e5be9691f"
      }
  }

사용 가능한 차원 및 지표

각 필드에 대한 설명은 메트릭 및 차원 용어집을 참조하세요.

네트워크 데이터

트래커 데이터

결합된 데이터

데이터 가용성 엔드포인트

사용법

이 엔드포인트는 주어진 날짜에 대해 각 소스 또는 데이터 커넥터에서 데이터를 사용할 수 있는지 여부를 반환합니다.

일일 보고서를 실행하기 전에 이 엔드포인트를 사용하여 어제 데이터가 이미 사용 가능한지 여부를 확인하는 것이 좋습니다.

샘플 쿼리(Python)

import requests

  url = "https://api.singular.net/api/v2.0/data_availability_status"
  queryparams = {
    "api_key":"<API_KEY>",
    "expanded":"true",
    "format": "json",
    "data_date":"2021-02-01",
    "display_non_active_sources":"true"
  }
  
  response = requests.get(url=url, params=queryparams)

쿼리 매개변수

샘플 출력(확장된 경우=true)

{
      "status": 0, 
      "substatus": 0, 
      "value": {
          "is_all_data_available": false,
          "data_connectors": [{
              "data_connector_id": "dgd7934875", 
              "data_connector_source_name": "Vungle", 
              "data_connector_username": "ua@mycompany.com", 
              "is_active_last_30_days": true, 
              "is_available": true, 
              "is_empty_data": false, 
              "last_updated_utc": "2021-02-08T10:10:07", 
              "data_connector_timestamp_utc": "2021-02-08T10:10:07", 
              "status": "data populated"
          }, {
              "data_connector_id": "youi293478", 
              "data_connector_source_name": "IronSource", 
              "data_connector_username": "ua@mycompany.com", 
              "is_active_last_30_days": true, 
              "is_available": false, 
              "is_empty_data": "N/A", 
              "last_updated_utc": "N/A", 
              "data_connector_timestamp_utc": "N/A", 
              "status": "data not populated"
          }]
      }
  }

출력 파라미터

{'is_all_data available': false,
  'data_sources': [
  {'username': u'facebook@singular.net',
   'status': 'data populated',
   'is_empty_data': false,
   'is_active_last_30_days': true,
   'last_updated_utc': '2018-05-03T10:12:18'
   'source': u'Facebook',
   'is_available': true},
   {'username': u'vungle@singular.net',
   'status': 'data populated',
   'is_empty_data': true,
   'is_active_last_30_days': true,
   'last_updated_utc': '2018-05-03T10:12:18'
   'source': u'Vungle',
   'is_available': true},
   {'username': u'applovin@singular.net',
   'status': 'data not populated',
   'is_empty_data': N/A,
   'is_active_last_30_days': true,
   'last_updated_utc': N/A
   'source': u'Applovin',
   'is_available': false}
  ]}

보고서 상태 엔드포인트 가져오기

사용법

이 엔드포인트는 비동기 보고서 만들기엔드포인트를 사용하여 생성된 특정 보고서의 상태를 반환합니다. 보고서 실행이 완료된 경우 엔드포인트는 다운로드 URL도 반환합니다.

보고서가 실패한 경우 엔드포인트는 문제를 해결하는 데 사용할 수 있는 오류 메시지를 반환합니다( 오류 코드표와 API FAQ 및 문제해결 가이드 참조).

자세히 알아보려면 단일 보고서 API 가이드의 쿼리 프로세스섹션을 참조하세요.

중요:

• 보고서를 완료하는 데 최대 몇 분 정도 걸릴 수 있습니다.
• 보고서당 10초에 한 번 이상 보고서 상태 엔드포인트를 쿼리하지 마세요.
• 시간 제한을 설정하세요. 드물지만 보고서가 '대기 중' 또는 '시작됨' 상태로 멈출 수 있습니다. 30분 후에도 상태가 "완료됨" 또는 "실패됨"이 아닌 경우 보고서를 다시 제출하는 것이 좋습니다(그러면 쿼리할 새 보고서 ID가 제공됨).

샘플 쿼리

import requests
  url = "https://api.singular.net/api/v2.0/get_report_status"
  querystring = {
    "report_id":"5cfdb747dd45be9691f",
    "api_key": "<API KEY>"
  }
  response = requests.get(url=url, params=querystring)
  print(response.text)

쿼리 매개변수

샘플 출력

{
    "status": 0,
    "substatus": 0,
    "value": {
        "status": "DONE",
        "url_expires_in": 3600,
        "generated_url_time_in_utc": "2018-05-13T08:26:18.457690+00:00",
        "url_expired_time_in_utc": "2018-05-13T09:26:18.457690+00:00",
        "download_url": "https://singular-reports-results.s3.amazonaws.com/singular/xxxxxxxxx",
        "report_id": "5cfdb747dd45be9691f"
    }
  }

출력 매개변수

엔드포인트 필터

사용법

이 헬퍼 엔드포인트를 사용하여 보고서를 필터링할 수 있는 최신 차원 목록과 각 차원에 사용할 수 있는 값을 검색합니다.

샘플 쿼리

import requests
  url = "https://api.singular.net/api/v2.0/reporting/filters"
  params = {'api_key': "<API KEY>"}
  result = requests.get(url=url, params=params)
  print result.json()

쿼리 매개변수

샘플 출력

{
    "status": 0,
    "substatus": 0,
    "value": {
      "dimensions": [
        {
          "name": "os",
          "display_name": "OS",
          "values": [
              {"name": 4, "display_name": "Android"},
              {"name": 1, "display_name": "iOS"}
            ],
        },
        {
          "name": "source",
          "display_name": "Source",
          "values": [{"name": "adwords", "display_name": "AdWords"}]
        }
      ]
    }
  }

사용자 지정 차원 엔드포인트

사용법

이 엔드포인트를 사용하여 계정에 대해 구성된 모든 사용자 정의 차원의 ID를 검색합니다. 그런 다음 비동기 보고서 만들기 엔드포인트를 쿼리할 때 기본 차원 대신 또는 기본 차원에 추가하여 사용자 지정 차원 ID를 사용할 수 있습니다.

사용자 지정 차원과 그 생성 방법에 대해 자세히 알아보려면 사용자 지정 차원 FAQ를 참조하세요.

샘플 쿼리

import requests
  url = "https://api.singular.net/api/custom_dimensions"
  params = {'api_key': "<API KEY>"}
  result = requests.get(url=url, params=params)
  print result.json()

쿼리 매개변수

샘플 출력

{
    "status": 0,
    "substatus": 0,
    "value": {
      "custom_dimensions": [
        {"display_name": "Channel Type", "id": "e471cb6b83684532e5e83cd"},
        {"display_name": "Region", "id": "1dcfdb1ad861fba4b098e2"}
      ]
    }
  }

코호트 지표 엔드포인트

사용법

이 엔드포인트를 사용하여 계정에 사용할 수 있는 모든 코호트 지표와 코호트 기간을 검색하세요. 여기에는 추적하도록 Singular를 구성한 모든 인앱 이벤트가 포함됩니다( 이벤트 FAQ 참조). 그런 다음 비동기 보고서 만들기 엔드포인트에서 쿼리를 실행할 때 이러한 메트릭과 기간을 지정할 수 있습니다.

비동기 보고서 만들기 쿼리에서는 '표시 이름'이 아닌 지표의 '이름'을 사용해야 한다는 점에 유의하세요.

샘플 쿼리

import requests
  url = "https://api.singular.net/api/cohort_metrics"
  params = {'api_key': "<API KEY>"}
  result = requests.get(url=url, params=params)
  print result.json()

쿼리 매개변수

샘플 출력

{
      "status": 0,
      "substatus": 0,
      "value": {
          "metrics": [
              {"display_name": "ROI","name": "roi"},
              {"display_name": "Revenue","name": "revenue"}
          ],
          "periods": ["1d","3d","5d","7d","14d","30d","actual"]
      }
  }

출력 매개변수

전환 지표 엔드포인트

사용법

이 엔드포인트를 사용하여 계정에 사용할 수 있는 모든 전환 이벤트를 검색합니다. 그런 다음 비동기 보고서 만들기 엔드포인트에서 쿼리를 실행할 때 이러한 이벤트를 지표로 지정할 수 있습니다.

비동기 보고서 만들기 쿼리에서는 '표시 이름'이 아닌 지표의 '이름'을 사용해야 한다는 점에 유의하세요.

샘플 쿼리

import requests
  url = "https://api.singular.net/api/conversion_metrics"
  params = {'api_key': "<API KEY>"}
  result = requests.get(url=url, params=params)
  print result.json()

쿼리 매개변수

샘플 출력

{
    "status": 0, 
    "substatus": 0, 
    "value": {
      "metrics": [
        {"display_name": "5-second video view", "name": "87dfg34453hsfg6f"}, 
        {"display_name": "5-second video view CPE", "name": "87dfg34453hsfg6fCPE"},   
        {"display_name": "Sign up", "name": "iuq353fidr76w846fha"}, 
        {"display_name": "Sign up CPE", "name": "iuq353fidr76w846fhaCPE"}, 
        {"display_name": "Post engagement", "name": "b59cje9fcgw0th"}, 
        {"display_name": "Post engagement CPE", "name": "b59cje9fcgw0thCPE"},
      ]
    }
  }

출력 매개변수

오류 코드

Singular는 표준 HTTP 응답 코드를 사용하여 API 요청의 성공 또는 실패를 나타냅니다. 일반적으로 200 코드는 성공, 4xx 범위의 코드는 제공된 정보에 따라 실패한 오류(예: 필수 매개변수 생략), 5xx 코드는 기타 문제를 나타냅니다.

참고: 리포팅 API FAQ 및 문제 해결하기