Compartir a través de

Licitadores: servicio de informes guardados

  • Artículo

El servicio de informes guardados se puede usar para crear informes nuevos que se guardan y se pueden recuperar en cualquier momento. Son útiles para los informes que se ejecutan con frecuencia. El servicio de informes guardado actúa como contenedor alrededor del servicio de informes.

Nota:

Hay un límite de 100 000 filas por informe.

API de REST

Http (método) Endpoint Description
DELETE https://api.adnxs.com/saved-report/ID Elimine un informe guardado existente.
GET https://api.adnxs.com/saved-report Ver todos los informes guardados para el miembro.
GET https://api.adnxs.com/saved-report/ID Ver un informe guardado específico.
POST https://api.adnxs.com/saved-report Agregue un nuevo informe guardado.
PUT https://api.adnxs.com/saved-report/ID Modifique un informe guardado existente.

Campos JSON

Campo Tipo Descripción
category string Categoría del informe.
created_on string Fecha y hora en que se creó el informe guardado.
emails matriz Lista de correos electrónicos para enviar el informe. La matriz debe tener el formato ["email_address1@domain.com", "email_address2@domain.com", ...]
entity_id Entero Identificador de entidad del usuario que crea el informe. Esto establece el ámbito del informe.
expires_on string Fecha y hora en que expira un informe guardado. Esto está limitado actualmente a un año en el futuro. La fecha y hora se debe especificar con el formato "AAAA-MM-DD HH:MM:SS" donde la hora se especifica en formato de 24 horas.
Obligatorio activado: POST
format enumeración Formato en el que se guardarán los resultados del informe.
Valores posibles: "excel" o "csv".
id Entero Identificador interno asociado al informe guardado.
Obligatorio en: PUT
last_activity string Fecha y hora en que se modificó por última vez el informe guardado.
name string Nombre del informe que se muestra en . La longitud máxima es de 100 caracteres.
report object Informe definido en el mismo formato que se usa en el servicio de informes.
scheduling enumeración Frecuencia con la que se ejecuta el informe. Valores posibles: "daily", "weekly" o "monthly".

Ejemplos

Adición de un nuevo informe guardado para un publicador

    {
    "saved-report": {
        "name": "Seller Platform Billing Report 48 Hours JMS",
        "report": {
            "report_type": "seller_platform_billing",
            "columns": [
                "day",
                "imps",
                "seller_revenue"
            ],
            "timezone": "EST",
            "report_interval": "last_48_hours"
        },
        "scheduling": "daily",
        "format": "excel",
        "emails": [
            "ejones@xandr.com",
            "bsmith@xandr.com"
        ],
        "expires_on": "2014-08-05 11:22:33"
    }
}
 
$ curl -b cookies -c cookies -X POST -d @saved-report.json 'https://api.adnxs.com/saved-report' | json-pp
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":null,
        "num_elements":null,
        "saved_reports":[
            {
                "id":826,
                "name":"Seller Platform Billing Report 48 Hours JMS",
                "report":{
                    "report_type":"seller_platform_billing",
                    "columns":[
                        "day",
                        "imps",
                        "seller_revenue"
                    ],
                    "timezone":"EST",
                    "report_interval":"last_48_hours",
                    "filters":[
                        {
                            "seller_member_id":"7"
                        }
                    ]
                },
                "scheduling":"daily",
                "format":"excel",
                "emails":[
                    "jschneider@xandr.com",
                    "bsmith@xandr.com"
                ],
                "created_on":"2014-04-16 20:55:59",
                "expires_on":"2014-08-05 11:22:33",
                "category":null,
                "entity_id":null,
                "last_activity":"2014-04-16 20:55:59"
            }
        ]
        }
}

Ejecución y recuperación de un informe guardado

$ curl -b cookies -c cookies -X POST 'https://api.adnxs.com/report?saved_report_id=826' 
{
    "response":{
        "existing":false,
        "status":"OK",
        "report_id":"5f45fcccc5c4b4ba6fb9747bf6fc33b9"
        }
}
$ curl -b cookies -c cookies "https://api.adnxs.com/report?id=fa16873114e1d5697091069e45bccec0"
{
    "response":{
        "status":"OK",
        "report":{
            "name":null,
            "created_on":"2014-04-16 21:15:04",
            "json_request":
                                "{\"report\":
                                        {\"report_type\":\"seller_platform_billing\",
                    \"columns\":[
                        \"day\",
                        \"imps\",
                        \"seller_revenue\"
                    ],
                    \"timezone\":\"EST\",
                    \"report_interval\":\"last_48_hours\",
                    \"filters\":[
                        {
                            \"seller_member_id\":\"7\"
                        },
                        {
                            \"seller_member_id\":\"7\"
                        }
                    ]
                }
            }
            "data":"day,imps,seller_revenue\r\n",
        },
        "execution_status":"ready",
   }
}
 
$ curl -b cookies -c cookies -s "https://api.adnxs.com/report-download?id=fa16873114e1d5697091069e45bccec0" > report.csv

Actualización de un informe existente

$ cat add-columns-saved-report.json
{
    "saved_report": {
            "report":{
                "report_type":"seller_platform_billing",
                "columns":[
                    "day",
                    "imps",
                    "seller_revenue",
                    "bidder_id"       
                ],
                "timezone":"EST",
                "report_interval":"last_48_hours",
                "filters":[
                    {
                        "seller_member_id":"7"
                    }
                ]
            }
    }
}
 
$ curl -b cookies -c cookies -X PUT -d @add-column-saved-report.json 'https://api.adnxs.com/saved-report?id=826'
{
 "response": {
        "status":"OK",
        "count":1,
        "start_element":null,
        "num_elements":null,
        "id":"826",
        "saved_report":{
            "id":826,
            "name":"Seller Platform Billing Report 48 Hours JMS",
            "report":{
                "report_type":"seller_platform_billing",
                "columns":[
                    "day",
                    "imps",
                    "seller_revenue",
                    "bidder_id"
                ],
                "timezone":"EST",
                "report_interval":"last_48_hours",
                "filters":[
                    {
                        "seller_member_id":"7"
                    }
                ]
            },
            "scheduling":"daily",
            "format":"excel",
            "emails":[
                "jschneider@xandr.com",
                "bsmith@xandr.com"
            ],
            "created_on":"2014-04-16 20:55:59",
            "expires_on":"2014-08-05 11:22:33",
            "category":null,
            "entity_id":null,
            "last_activity":"2014-04-17 16:00:27"
        },
        "dbg":{
            ...
        }
    }
}