API de plateforme numérique - Rapport Curator Analytics

Le rapport d’analyse du curateur fournit aux conservateurs un aperçu de la façon dont l’argent circule de la demande à l’offre au sein de leur place de marché organisée.

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

Période

Le report_interval champ dans la requête JSON peut être défini sur l’une des valeurs suivantes :

• last_hour
• aujourd’hui
• yesterday
• month_to_date
• last_month
• Vie

Période de conservation des données

Les données de ce rapport sont conservées pendant 1100 jours.

Intervalles de temps, y compris les dates se produisant il y a plus de 45 jours

Si vous créez des rapports Curator Analytics avec la report_interval valeur définie "lifetime"sur , votre rapport (quelles que soient les métriques incluses) sera ajouté à une file d’attente spéciale pour les rapports « gourmands en ressources ». Par conséquent, le rapport peut prendre plus de temps que d’habitude. En outre, ces rapports gourmands en ressources peuvent, en raison de la quantité de données demandées, échouer avant d’être terminés. Si votre rapport ne se termine pas, vous recevrez une notification. Si votre demande de rapport échoue ou est supprimée, vous pouvez :

• réexécutez le rapport ultérieurement.
• utiliser un type de rapport autre que curator_analytics.
• modifiez la façon dont vous structurez vos rapports (si possible) afin qu’ils n’incluent pas de dates supérieures à 45 jours.

Dimensions

Mesures

Exemple

Create une demande de rapport au format JSON

Le fichier JSON doit inclure le report_type de "curator_analytics", ainsi que le columns (dimensions et métriques) et report_interval que vous souhaitez récupérer. Vous pouvez également filtrer des dimensions spécifiques, définir la granularité (year, month, day) et spécifier le format dans lequel les données doivent être retournées (csv, excelou html). Pour obtenir une explication complète des champs qui peuvent être inclus dans le fichier JSON, consultez service de rapports.

$ cat curator_analytics

{
    "report": {
        "columns": [
            "hour",
            "buyer_member_name",
            "curated_deal",
            "imps",
            "curator_revenue",
            "curator_margin"
        ],
        "format": "csv",
        "report_interval": "today",
        "report_type": "curator_analytics"
    }
}

POST la demande au service de rapport

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

{
   "response":{
      "status":"OK",
      "report_id":"6b177543a9411ffa67b09bdf5e76cac1"
   }
}

GETle rapport status à partir du service de rapports

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 'https://api.appnexus.com/report?id=6b177543a9411ffa67b09bdf5e76cac1'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2020-08-25 13:03:37",
         "json_request":"{\"report\":{\"report_type\":\"curator_analytics\",\"columns\":[\"hour\",\"buyer_member_name\",\"curated_deal\",\"imps\",\"curator_revenue\",\"curator_margin\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"member_id\":\"123456\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1598400000,\"start_date\":1598313600,\"user_id\":\"987654\"}",
         "url": "report-download?id=6b177543a9411ffa67b09bdf5e76cac1"
      },
      "execution_status":"ready"
   }
}

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 'https://api.appnexus.com/report-download?id=6b177543a9411ffa67b09bdf5e76cac1' > /tmp/curator_analytics.csv