Get User API Usage Metrics (Admin)

This endpoint retrieves API usage metrics for a specified user, allowing filtering by date range and an optional list of API key names. This endpoint is only accessible to administrators.

Authorization

Authorization<token>

Bearer token for authentication. Type "Bearer" followed by a space and JWT token. Example: "Bearer YOUR_JWT_TOKEN"

In: header

Request Body

API Usage Metric Request Body - Contains user alias, filters for date range, and optional list of API key names.

aliasstring

Length1 <= length <= 64

api_key_names?array<string>

end_datestring

start_datestring

Response Body

curl -X POST "https://andamio-api-preprod-308006323670.us-central1.run.app/api/v1/admin/usage/user-api-usage" \
  -H "Content-Type: application/json" \
  -d '{
    "alias": "johndoe",
    "end_date": "2023-01-31",
    "start_date": "2023-01-01"
  }'

const body = JSON.stringify({
  "alias": "johndoe",
  "end_date": "2023-01-31",
  "start_date": "2023-01-01"
})

fetch("https://andamio-api-preprod-308006323670.us-central1.run.app/api/v1/admin/usage/user-api-usage", {
  body
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://andamio-api-preprod-308006323670.us-central1.run.app/api/v1/admin/usage/user-api-usage"
  body := strings.NewReader(`{
    "alias": "johndoe",
    "end_date": "2023-01-31",
    "start_date": "2023-01-01"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://andamio-api-preprod-308006323670.us-central1.run.app/api/v1/admin/usage/user-api-usage"
body = {
  "alias": "johndoe",
  "end_date": "2023-01-31",
  "start_date": "2023-01-01"
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;
import java.net.http.HttpRequest.BodyPublishers;

var body = BodyPublishers.ofString("""{
  "alias": "johndoe",
  "end_date": "2023-01-31",
  "start_date": "2023-01-01"
}""");
HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://andamio-api-preprod-308006323670.us-central1.run.app/api/v1/admin/usage/user-api-usage"))
  .header("Content-Type", "application/json")
  .POST(body)
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

using System;
using System.Net.Http;
using System.Text;

var body = new StringContent("""
{
  "alias": "johndoe",
  "end_date": "2023-01-31",
  "start_date": "2023-01-01"
}
""", Encoding.UTF8, "application/json");

var client = new HttpClient();
var response = await client.PostAsync("https://andamio-api-preprod-308006323670.us-central1.run.app/api/v1/admin/usage/user-api-usage", body);
var responseBody = await response.Content.ReadAsStringAsync();

{
  "alias": "johndoe",
  "api_usage_metrics": [
    {
      "api_key_name": "MyFirstKey",
      "usage_metrics": [
        {
          "api_key_name": "MyFirstKey",
          "api_version": "v1",
          "authentication_method": "API_KEY",
          "cache_hit": false,
          "created_at": "2023-01-01T12:34:56Z",
          "data_transfer_in_bytes": 1024,
          "data_transfer_out_bytes": 2048,
          "endpoint": "/v1/data",
          "error_count": 0,
          "http_method": "GET",
          "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
          "ip_address": "192.168.1.1",
          "latency_to_db_ms": 20,
          "quota_exceeded": false,
          "rate_limit_type": "minute",
          "rate_limited": false,
          "remaining_quota": 999,
          "remaining_rate_limit": 99,
          "request_body_size_bytes": 100,
          "request_count": 1,
          "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
          "response_body_size_bytes": 500,
          "response_time_ms": 150,
          "status_code": 200,
          "tier_id": 1,
          "tier_name": "Free",
          "timestamp": "2023-01-01T12:34:56Z",
          "updated_at": "2023-01-01T12:34:56Z",
          "user_agent": "Mozilla/5.0",
          "user_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
        }
      ]
    }
  ]
}

{
  "details": "string",
  "message": "Bad Request: Invalid input.",
  "status_code": 400
}

{
  "details": "string",
  "message": "Unauthorized: Invalid or missing credentials.",
  "status_code": 401
}

{
  "details": "string",
  "message": "Forbidden: Insufficient permissions or tier access.",
  "status_code": 403
}

{
  "details": "string",
  "message": "Unprocessable Entity: Invalid request structure or data.",
  "status_code": 422
}

{
  "details": "string",
  "message": "Too Many Requests: Rate limit or quota exceeded.",
  "status_code": 429
}

{
  "details": "string",
  "message": "Internal Server Error: An unexpected error occurred.",
  "status_code": 500
}