Skip to content
POST/api/v1/prompts/analytics

Record a prompt usage event

SDK clients call this after each prompt invocation to record latency, quality, token usage and cost for the analytics dashboard.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Request body required

Example

{
  "name": "string",
  "version": 1,
  "latencyMs": 0,
  "qualityScore": 0,
  "tokens": {
    "input": 0,
    "output": 0
  },
  "cost": 0,
  "success": false
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "name",
        "version",
        "latencyMs",
        "qualityScore"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "version": {
          "type": "integer",
          "minimum": 1
        },
        "latencyMs": {
          "type": "number"
        },
        "qualityScore": {
          "type": "number"
        },
        "tokens": {
          "type": "object",
          "properties": {
            "input": {
              "type": "integer"
            },
            "output": {
              "type": "integer"
            }
          }
        },
        "cost": {
          "type": "number"
        },
        "success": {
          "type": "boolean"
        }
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Recorded ({ recorded: true }).
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/prompts/analytics \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "string", "version": 1, "latencyMs": 0, "qualityScore": 0, "tokens": { "input": 0, "output": 0 }, "cost": 0, "success": false }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/prompts/analytics", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "version": 1,
    "latencyMs": 0,
    "qualityScore": 0,
    "tokens": {
      "input": 0,
      "output": 0
    },
    "cost": 0,
    "success": false
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/prompts/analytics",
    headers=headers,
    json={
    "name": "string",
    "version": 1,
    "latencyMs": 0,
    "qualityScore": 0,
    "tokens": {
        "input": 0,
        "output": 0
    },
    "cost": 0,
    "success": False
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name":"string","version":1,"latencyMs":0,"qualityScore":0,"tokens":{"input":0,"output":0},"cost":0,"success":false}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/prompts/analytics", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429500

Other Prompts endpoints