Analyse-REST-API

Vorgehensweise zum Zugreifen auf Ihre Analysedaten mit der REST-API.

1. Erstellen Sie einen -API-Schlüssel. Weitere Informationen zum Erstellen eines API-Schlüssels finden Sie unter Verwalten von Plattform-REST-API-Schlüsseln.
2. Verwenden Sie Ihren API-Schlüssel, um ein Überbringer-Token anzufordern:

   curl -v -k -X POST -d '{"api_key": "<api_key>", "client_id": "<client_id>", "client_secret": "<client_secret>", "grant_type": "api_key"}' -H 'Content-Type: application/json' -H 'Accept: application/json' https://<management_server_platform_api_endpoint>/api/token

   Dabei gilt:

   • <api-key> ist der API-Schlüssel, den Sie generiert haben.
   • <client_id> ist die Client-ID aus dem Abschnitt "Toolkit" der Datei credentials.json oder wie von Ihrem API Connect Cloud-Administrator angegeben.
   • <client_secret> ist das Client-Geheimnis aus dem Abschnitt "Toolkit" der Datei credentials.json oder wie von Ihrem API Connect Cloud-Administrator bereitgestellt.
   Das Trägertoken wird in der Eigenschaft access_token zurückgegeben:

   {
       "access_token": "<bearer_token>",
       "token_type": "Bearer",
       "expires_in": 28800
   }

   Notieren Sie den Wert für expires_in , d. h. die Anzahl der Sekunden bis zum Ablauf des Tokens. Nach dem Ablauf müssen Sie ein neues Trägertoken anfordern.

3. Verwenden Sie das zurückgegebene Träger-Token, um die REST-API für Analysen aufzurufen.

   # This call to /orgs/<provider_organization>/events requires a bearer token that was requested with provider org credentials:
   curl -k -H 'Authorization: Bearer <bearer_token>' -X GET --url 'https://<platform api endpoint>/analytics/<analytics_service>/orgs/<provider_organization>/events'
   
   {
       "total": 300,
       "search_time": 3,
       "events": [...]
   }
   
   # This call to the consumer API: orgs/<consumer org>/dashboard, requires a bearer token that was requested with consumer org credentials.
   curl -k -H 'X-IBM-Consumer-Context: <provider org>.<catalog>' -H 'Authorization: Bearer <bearer_token>' -X GET --url 'https://<consumer api endpoint>/consumer-analytics/orgs/<consumer org>/dashboard' 
   {
       "search_time": 16,
       "status_codes": {
           "total": 300,
           "data": [...]
       },
       "min_response_time": {
           "data": ...
       ...
   
   
   

   Dabei gilt:

   • <platform api endpoint> ist die toolkit.endpoint, jedoch mit /api am Ende, das durch /analytics ersetzt wird, um auf die Analyse-APIs zuzugreifen.
   • <analytics_service> ist der Name des Analyseservice.
   • <Bearer_token> ist das Token aus Schritt 2. Schließen Sie das Token nicht in Anführungszeichen ein.
4. Verwenden Sie Abfrageparameter, um Ihre Ergebnisse zu filtern und nur bestimmte Felder anzuzeigen.
   Wenn Sie nach bestimmten Analyse-Ereignisdatensätzen suchen möchten, fügen Sie die Abfrageparameter an den API-Aufruf an. So erhalten Sie beispielsweise nur Ereignisdaten für Aufrufe einer bestimmten API und eines bestimmten Produkts:

   /events?api_name=<api name>&product_name=<product name>

   Um nur bestimmte API-Ereignisdatensatzfelder in der Ausgabe zu erhalten, fügen Sie denfields Abfrageparameter. Um beispielsweise nur den API-Namen und die Uhrzeit des Aufrufs abzurufen:

   /events?fields=api_name,datetime

   Um nur Ereignisse vor oder nach einer bestimmten Zeit abzurufen, verwenden Sie diestart Undend Parameter. Zum Beispiel:

   /events?start=2024-07-11T10:01:00.000Z&end=2024-07-11T10:02:00.000Z