Partager via

Soumissionnaires - Service de rapports enregistrés

Le service Rapport enregistré peut être utilisé pour créer des rapports qui sont enregistrés et peuvent être récupérés à tout moment. Elles sont utiles pour les rapports qui sont exécutés fréquemment. Le service de rapports enregistrés agit comme un wrapper autour du service de rapports.

Remarque

Il existe une limite de 100 000 lignes par rapport.

API REST

HTTP, méthode Endpoint Description
SUPPRIMER https://api.adnxs.com/saved-report/ID Supprimer un rapport enregistré existant.
GET https://api.adnxs.com/saved-report Affichez tous les rapports enregistrés pour votre membre.
GET https://api.adnxs.com/saved-report/ID Afficher un rapport enregistré spécifique.
POST https://api.adnxs.com/saved-report Ajoutez un nouveau rapport enregistré.
PUT https://api.adnxs.com/saved-report/ID Modifier un rapport enregistré existant.

Champs JSON

Champ Type Description
category string Catégorie du rapport.
created_on chaîne Date et heure de création du rapport enregistré.
emails tableau Liste des e-mails pour envoyer le rapport. Le tableau doit être au format ["email_address1@domain.com", "email_address2@domain.com", ...]
entity_id int ID d’entité de l’utilisateur qui crée le rapport. Cela définit l’étendue du rapport.
expires_on string Date et heure d’expiration d’un rapport enregistré. Ce délai est actuellement limité à un an à l’avenir. La date/heure doit être spécifiée au format « AAAA-MM-JJ HH :MM :SS », où l’heure est spécifiée au format 24 heures.
Obligatoire sur : POST
format enum Format dans lequel les résultats du rapport seront enregistrés.
Valeurs possibles : « excel » ou « csv ».
id int ID interne associé au rapport enregistré.
Obligatoire sur : PUT
last_activity chaîne Date et heure de la dernière modification du rapport enregistré.
name string Nom du rapport affiché dans . La taille maximale est de 100 caractères.
report objet Rapport défini dans le même format que celui utilisé dans le service de rapports.
scheduling enum Fréquence d’exécution du rapport. Valeurs possibles : « daily », « weekly » ou « monthly ».

Exemples

Ajout d’un nouveau rapport enregistré pour un serveur de publication

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

Exécution et récupération d’un rapport enregistré

$ 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

Mise à jour d’un rapport existant

$ 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":{
            ...
        }
    }
}
  • Last updated on