Información general

Autenticación

Todas las solicitudes de API requieren una clave de API. Para recuperar la clave, inicie sesión en su cuenta y vaya a Herramientas para desarrolladores > Claves API. Puede insertar la clave en el parámetro api_key de su solicitud o proporcionar el token en un encabezado HTTP de autorización.

Límites de tarifa

Los límites por defecto para Singular API son:

• Informes asíncronos: hasta 100 informes asíncronos ejecutándose simultáneamente.
• Informes síncronos: hasta 3 informes síncronos ejecutándose simultáneamente.
• Límite de filas por informe: hasta 200.000 filas por consulta.
• Límite diario global de filas: hasta 3M de filas en un solo día (compartido entre todas sus consultas).

Singular se reserva el derecho de ajustar el límite de filas para determinados puntos finales con el fin de continuar y proporcionar una alta calidad de servicio a todos nuestros clientes. Póngase en contacto con nosotros si tiene una necesidad específica de superar la limitación predeterminada.

Lista de puntos finales de la API de informes

Están disponibles los siguientes puntos finales de la API:

Punto final de creación de informes asíncronos

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"
      }
  }

Dimensiones y métricas disponibles

Consulte el Glosario demétricas y dimensiones para obtener una descripción de cada campo.

Datos de red

Datosdel rastreador

Datos combinados

Disponibilidad de datos Endpoint

Uso

Este endpoint devuelve si, para un día determinado, los datos están disponibles para cada una de sus fuentes o conectores de datos.

Recomendamos utilizar este endpoint para comprobar si los datos ya están disponibles para ayer antes de ejecutar su(s) informe(s) diario(s).

Ejemplo de consulta (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)

Parámetros de consulta

Ejemplo de salida (cuando expanded=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"
          }]
      }
  }

Parámetros de salida

{'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}
  ]}

Obtener estado del informe Endpoint

Utilización

Este endpoint devuelve el estado de un informe dado que se generó utilizando el endpoint Crear Informe Asíncrono. Si el informe ha terminado de ejecutarse, el endpoint también devuelve una URL de descarga.

Si el informe ha fallado, el endpoint devuelve un mensaje de error que puede utilizar para solucionar el problema (consulte la tabla Códigos de errory la guía Preguntas frecuentes y resolución de problemas de la API).

Para obtener más información, consulte la sección Proceso de consultaen la Guía de la API de Singular Reporting.

Importante:

• En ocasiones, los informes pueden tardar unos minutos en completarse.
• No consulte el punto final del estado del informe más de una vez cada 10 segundos por informe.
• Establezca un tiempo de espera. En algunos casos poco frecuentes, un informe puede quedarse atascado en el estado "En cola" o "Iniciado". Si el estado no es "Listo" o "Fallido" después de 30 minutos, le recomendamos que vuelva a enviar el informe (lo que le proporcionará un nuevo ID de informe para consultar).

Ejemplo de consulta

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)

Parámetros de consulta

Muestra de salida

{
    "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"
    }
  }

Parámetros de salida

Filtros Punto final

Uso

Utilice este endpoint de ayuda para recuperar una lista actualizada de las dimensiones por las que puede filtrar su informe y los valores posibles para cada dimensión.

Ejemplo de consulta

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()

Parámetros de consulta

Salida de muestra

{
    "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"}]
        }
      ]
    }
  }

Extremo de dimensiones personalizadas

Uso

Utilice este punto final para recuperar los ID de cualquier dimensión personalizada configurada para su cuenta. A continuación, puede utilizar los ID de dimensiones personalizadas al consultar el punto final Crear informe asíncrono (en lugar de o además de cualquiera de las dimensiones predeterminadas).

Para obtener más información sobre las dimensiones personalizadas y cómo crearlas, consulte las Preguntas frecuentes sobre dimensiones personalizadas.

Ejemplo de consulta

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()

Parámetros de consulta

Salida de la muestra

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

Punto final de métricas de cohortes

Uso

Utilice este endpoint para recuperar todas las métricas y periodos de cohorte disponibles para su cuenta. Esto incluye cualquier evento dentro de la aplicación que haya configurado para que Singular rastree (consulte las preguntas frecuentes sobre eventos). A continuación, puede especificar estas métricas y periodos cuando ejecute una consulta en el punto final Crear informe asíncrono.

Tenga en cuenta que en la consulta Crear informe asíncrono debe utilizar el "nombre" de la métrica, no el "nombre para mostrar".

Ejemplo de consulta

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()

Parámetros de consulta

Muestra de salida

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

Parámetros de salida

Punto final de métricas de conversión

Uso

Utilice este endpoint para recuperar todos los eventos de conversión disponibles para su cuenta. A continuación, puede especificar estos eventos como métricas cuando ejecute una consulta en el punto final Crear informe asíncrono.

Tenga en cuenta que en la consulta Crear informe asíncrono debe utilizar el "nombre" de la métrica, no el "nombre para mostrar".

Ejemplo de consulta

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()

Parámetros de consulta

Muestra de salida

{
    "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"},
      ]
    }
  }

Parámetros de salida

Códigos de error

Singular utiliza códigos de respuesta HTTP estándar para indicar el éxito o el fracaso de una solicitud API. En general, los códigos 200 corresponden a éxito, los códigos en el rango 4xx indican un error que falló dada la información proporcionada (por ejemplo, se omitió un parámetro requerido), y los códigos 5xx son para otros problemas.

Véase también: Preguntas frecuentes sobre la API de informes y Resolución de problemas