Compartir a través de

API de plataforma digital: informe de cargas de segmentos

  • Artículo

El informe Cargas de segmento permite ver métricas sobre los segmentos, incluido el número total de cargas de píxeles de segmento y el número de identificadores de usuario únicos incluidos en momentos específicos.

Para obtener instrucciones sobre cómo recuperar un informe, consulte Report Service o los ejemplos siguientes.

Nota:

Debe seleccionar los segmentos compartidos explícitamente para informar sobre ellos.

Período de tiempo

El report_interval campo de la solicitud JSON se puede establecer en:

  • hoy
  • yesterday
  • last_48_hours
  • last_7_days
  • month_to_date

Sugerencia

Para ejecutar un informe para un período de tiempo personalizado, establezca los campos y end_date en la start_date solicitud de informe. Para obtener más información sobre estos campos, vea Report Service.

Dimensions

Column Tipo ¿Filtro? Ejemplo Descripción
segment_id Entero sí 220 Identificador del segmento.
segment_name string no "Submitted application" Nombre del segmento.
segment string no "Submitted application (220)" En desuso (a partir del 17 de octubre de 2016).
day time sí 2011-01-06 El día para el que desea métricas de segmento.
month time sí 2011-01 Mes para el que desea métricas de segmento.

Métricas

Column Tipo Ejemplo Descripción
total_loads Entero 28375 El número total de veces que se cargó el píxel del segmento.
daily_uniques Entero 556 Número de identificadores de usuario únicos agregados al segmento en un día específico. Para ver esta métrica, debe incluir la dimensión day.
monthly_uniques Entero 10998 Número de identificadores de usuario únicos agregados al segmento en un mes específico. Para ver esta métrica, debe incluir la dimensión month.
avg_daily_uniques Entero 675 Número medio de usuarios agregados a un segmento por día para un mes específico. Para ver esta métrica, debe incluir la dimensión month.

Ejemplos

Visualización de métricas diarias mensuales y medias para todos los segmentos

  1. Create la solicitud JSON para el informe.

    $ cat segment_load
{
    "report":
    {
        "report_type": "segment_load",
        "columns": [
            "segment_id",
            "segment_name",
            "month",
            "total_loads",
            "monthly_uniques",
            "avg_daily_uniques"
        ],
        "groups": [
            "segment_id",
            "month"
        ],
        "orders": [
            "month"
        ],
        "emails": ["js@email.com"],
        "format": "csv"
    }
}

  2. POST la solicitud al servicio de informes.

    $ curl -b cookies -c cookies -X POST -d @segments_monthly 'https://api.appnexus.com/report'

{
    "response":{
        "status":"OK",
        "report_id":"07af1282c9485adcef49c95fa5d7496b"
    }
}

  3. GET el estado del informe del servicio de informes.

    Realice una GET llamada con el identificador de informe para recuperar el estado del informe. Continúe realizando esta GET llamada hasta que execution_status sea "ready". A continuación, use el servicio de descarga de informes para guardar los datos del informe en un archivo, como se describe en el paso siguiente.

    $ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=07af1282c9485adcef49c95fa5d7496b'

{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2012-02-10 16:41:39",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": null,
            "json_request": "{\"report\":{\"report_type\":\"segment_load\",\"columns\":
             [\"segment_id\",\"segment_name\",\"month\",\"total_loads\",\"monthly_uniques\",
             \"avg_daily_uniques\"],\"groups\":[\"segment_id\",\"month\"],\"orders\":
             [\"month\"],\"emails\":[\"js@email.com\"],\"row_per\":[\"segment_id\",
             \"month\"]}}",
            "header_info": "Report type:,segment_load\u000d\u000a,\u000d\u000aRun at:,
             2012-02-10 16:41:39\u000d\u000aStart date:,\u000d\u000aEnd date:,\u000d\u000aTimezone:,
             \u000d\u000aUser:,John Smith (10055)\u000d\u000a",
            "url": "report-download?id=07af1282c9485adcef49c95fa5d7496b"
        },
        "execution_status": "ready"
    }
}

  4. GET los datos del informe del servicio de descarga de informes.

    Para descargar los datos del informe en un archivo, realice otra GET llamada con el identificador de informe, pero esta vez al servicio de descarga de informes . Puede encontrar el servicio y el identificador de informe en el url campo de la respuesta anterior GET . Al identificar el archivo en el que desea guardar, asegúrese de usar la extensión de archivo de "format" que especificó en su inicial POST.

    curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=07af1282c9485adcef49c95fa5d7496b' > /temp/segement_load.csv

Visualización de métricas diarias para el segmento 184531

  1. Create la solicitud JSON para el informe.

    Nota:

    Para obtener métricas para un segmento específico, debe filtrar el informe por segment_id.

    $ cat segment_daily

{
    "report":
    {
        "report_type": "segment_load",
        "columns": [
            "segment_id",
            "segment_name",
            "day",
            "total_loads",
            "daily_uniques"
        ],
        "filters": [
            {
                "segment_id": 184531
            }
        ],
        "groups": [
            "segment_id",
            "day"
        ],
        "orders": [
            "day"
        ],
        "emails": ["js@email.com"],
        "format": "csv"
    }
}

  2. POST la solicitud al servicio de informes.

    $ curl -b cookies -c cookies -X POST -d segment_load 'https://api.appnexus.com/report'

{
    "response":{
        "status":"OK",
        "report_id":"c5975474b00c68f3cd1db49b8fe758da"
    }
}

  3. GET el estado del informe del servicio de informes.

    Realice una GET llamada con el identificador de informe para recuperar el estado del informe. Continúe realizando esta GET llamada hasta que execution_status sea "ready". A continuación, use el servicio de descarga de informes para guardar los datos del informe en un archivo, como se describe en el paso siguiente.

    $ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=c5975474b00c68f3cd1db49b8fe758da'

{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2012-02-10 15:52:16",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": null,
            "json_request": "{\"report\":{\"report_type\":\"segment_load\",\"columns\":
             [\"segment_id\",\"segment_name\",\"day\",\"total_loads\",\"daily_uniques\"],
             \"filters\":[{\"segment_id\":184531}],\"groups\":[\"segment_id\",\"day\"],
             \"orders\":[\"day\"],\"emails\":[\"js@email.com\"],\"row_per\":
             [\"segment_id\",\"day\"]}}",
            "header_info": "Report type:,segment_load\u000d\u000a,\u000d\u000aRun at:,
             2012-02-10 15:52:16\u000d\u000aStart date:,\u000d\u000aEnd date:,
             \u000d\u000aTimezone:,\u000d\u000aUser:,John Smith (10356)\u000d\u000a",
            "url": "report-download?id=c5975474b00c68f3cd1db49b8fe758da"
        },
        "execution_status": "ready"
    }
}

  4. GET los datos del informe del servicio de descarga de informes.

    Para descargar los datos del informe en un archivo, realice otra GET llamada con el identificador de informe, pero esta vez al servicio de descarga de informes . Puede encontrar el servicio y el identificador de informe en el url campo de la respuesta anterior GET . Al identificar el archivo en el que desea guardar, asegúrese de usar la extensión de archivo de "format" que especificó en su inicial POST.

    curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=c5975474b00c68f3cd1db49b8fe758da' > /temp/segment_load.csv

    Nota:

    Hay un límite de 100 000 filas por informe cuando se descargan como archivos XLSX y Excel.