Partager via


API de plateforme numérique - Rapport Chargements de segments

Le rapport Chargements de segments vous permet d’afficher les métriques relatives à vos segments, notamment le nombre total de chargements de pixels de segment et le nombre d’ID utilisateur uniques inclus à des moments spécifiques dans le temps.

Pour obtenir des instructions sur la récupération d’un rapport, consultez Service de rapports ou les exemples ci-dessous.

Remarque

Vous devez sélectionner les segments partagés explicitement pour créer des rapports sur ceux-ci.

Période

Le report_interval champ dans la requête JSON peut être défini sur :

  • aujourd’hui
  • yesterday
  • last_48_hours
  • last_7_days
  • month_to_date

Conseil

Pour exécuter un rapport pour une période personnalisée, définissez les start_date champs et end_date dans votre demande de rapport. Pour plus d’informations sur ces champs, consultez Service de rapports.

Dimensions

Column Type Filtre? Exemple Description
segment_id int oui 220 ID du segment.
segment_name string Non "Submitted application" Nom du segment.
segment string Non "Submitted application (220)" Déconseillé (à compter du 17 octobre 2016).
day Temps oui 2011-01-06 Jour pour lequel vous souhaitez des métriques de segment.
month Temps oui 2011-01 Mois pour lequel vous souhaitez obtenir des métriques de segment.

Mesures

Column Type Exemple Description
total_loads int 28375 Nombre total de fois que le pixel de segment a été chargé.
daily_uniques int 556 Nombre d’ID utilisateur uniques ajoutés au segment sur un jour spécifique. Pour afficher cette métrique, vous devez inclure la dimension jour.
monthly_uniques int 10998 Nombre d’ID utilisateur uniques ajoutés au segment au cours d’un mois spécifique. Pour afficher cette métrique, vous devez inclure la dimension mois.
avg_daily_uniques int 675 Nombre moyen d’utilisateurs ajoutés à un segment par jour pour un mois spécifique. Pour afficher cette métrique, vous devez inclure la dimension mois.

Exemples

Afficher les métriques quotidiennes mensuelles et moyennes pour tous les segments

  1. Create la requête JSON pour le rapport.

    $ 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 demande adressée au service de rapports.

    $ curl -b cookies -c cookies -X POST -d @segments_monthly 'https://api.appnexus.com/report'
    
    {
        "response":{
            "status":"OK",
            "report_id":"07af1282c9485adcef49c95fa5d7496b"
        }
    }
    
  3. GETle rapport status à partir du service Rapport.

    Effectuez un GET appel avec l’ID de rapport pour récupérer les status du rapport. Continuez à effectuer cet GET appel jusqu’à ce que soit execution_status"ready". Utilisez ensuite le service de téléchargement de rapports pour enregistrer les données du rapport dans un fichier, comme décrit à l’étape suivante.

    $ 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 les données de rapport du service de téléchargement de rapports.

    Pour télécharger les données du rapport dans un fichier, effectuez un autre GET appel avec l’ID de rapport, mais cette fois au service de téléchargement de rapports . Vous trouverez le service et l’ID de rapport dans le url champ de la réponse précédente GET . Lorsque vous identifiez le fichier dans lequel vous souhaitez enregistrer, veillez à utiliser l’extension de fichier du "format" que vous avez spécifié dans votre initial POST.

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

Afficher les métriques quotidiennes pour le segment 184531

  1. Create la requête JSON pour le rapport.

    Remarque

    Pour obtenir des métriques pour un segment spécifique, vous devez filtrer le rapport par 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 demande adressée au service de rapport.

    $ curl -b cookies -c cookies -X POST -d segment_load 'https://api.appnexus.com/report'
    
    {
        "response":{
            "status":"OK",
            "report_id":"c5975474b00c68f3cd1db49b8fe758da"
        }
    }
    
  3. GETle rapport status à partir du service Rapport.

    Effectuez un GET appel avec l’ID de rapport pour récupérer les status du rapport. Continuez à effectuer cet GET appel jusqu’à ce que soit execution_status"ready". Utilisez ensuite le service de téléchargement de rapports pour enregistrer les données du rapport dans un fichier, comme décrit à l’étape suivante.

    $ 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 les données de rapport du service de téléchargement de rapports.

    Pour télécharger les données du rapport dans un fichier, effectuez un autre GET appel avec l’ID de rapport, mais cette fois au service de téléchargement de rapports . Vous trouverez le service et l’ID de rapport dans le url champ de la réponse précédente GET . Lorsque vous identifiez le fichier dans lequel vous souhaitez enregistrer, veillez à utiliser l’extension de fichier du "format" que vous avez spécifié dans votre initial POST.

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

    Remarque

    Il existe une limite de 100 000 lignes par rapport lorsque vous les téléchargez en tant que fichier XLSX et Excel.