API de plataforma digital: informe de rendimiento del segmento Curator

El Informe de rendimiento del segmento del curador proporciona a los curadores información sobre cómo sus segmentos objetivo están contribuyendo al rendimiento general de sus acuerdos seleccionados. El informe proporciona datos de todos los segmentos segmentados (incluye y excluye) que contribuyeron a las impresiones de transacciones. Para los curadores, esto incluye toda la actividad de acuerdos curados.

Para obtener instrucciones sobre cómo recuperar un informe, consulte Servicio de informes o el ejemplo siguiente.

Período de tiempo

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

• last_hour
• last_48_hours
• hoy
• yesterday
• last_7_days
• month_to_date
• quarter_to_date
• last_month
• last_30_days

Período de retención de datos

Los datos de este informe se conservan durante 429 días.

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 Servicio de informes.

Dimensions

Métricas

Ejemplo

Crear una solicitud de informe con formato JSON

El archivo JSON debe incluir el report_type de "curator_segment_performance", así como el columns (dimensiones y métricas) y report_interval que desea recuperar. También puede filtrar por dimensiones específicas, definir la granularidad (year, month, day) y especificar el formato en el que se deben devolver los datos (csv, excel, o html). Para obtener una explicación completa de los campos que se pueden incluir en el archivo JSON, vea el servicio de informes.

$ cat curator_segment_performance

{
    "report": {
        "report_type": "curator_segment_performance",
        "columns": [
            "curated_deal_id",
            "cureated_deal_name",
            "segment_id",
            "segment_name",
            "targeting_type",
            "targeted_impressions",
            "targeted_curator_revenue"
        ],
        "report_interval": "today",
        "format": "csv"
    }
}

POST la solicitud al servicio de informes

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

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

GET el estado del informe desde el servicio de informes

Realice una GET llamada con el ID de informe para recuperar el estado del informe. Continúe realizando esta GET llamada hasta que se execution_status ."ready" Después, 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 'https://api.appnexus.com/report?id=a2c95fcff2d8759e69cec123364f9b32'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2020-09-04 12:46:08",
            "json_request": "{\"report\":{\"report_type\":\"curator_segment_performance\",\"columns\":[\"curated_deal_id\",\"cureated_deal_name\",\"segment_id\",\"segment_name\",\"targeting_type\",\"targeted_impressions\",\"targeted_curator_revenue\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"curator_member_id\":\"12025\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1599264000,\"start_date\":1599177600,\"user_id\":\"123456\"}",
            "url": "report-download?id=a2c95fcff2d8759e69cec123364f9b32"
        },
        "execution_status": "ready"
    }
}

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 ID del informe, pero esta vez al servicio de descarga de informes . Puede encontrar el servicio y el ID de informe en el url campo de la respuesta anterior GET . Al identificar el archivo en el que desea guardarlo, asegúrese de usar la extensión de archivo que especificó en POSTel "format" archivo .

$ curl -b cookies 'https://api.appnexus.com/report-download?id=a2c95fcff2d8759e69cec123364f9b32' > /tmp/curator_segment_performance.csv