Get contract line usage metrics

Returns usage and cost metrics for a contract line over a time window.

Path parameters

idstring <uuid>Required

Contract line UUID from contract_lines.contract_line_id.

Query parameters

period_startstring <date-time>Optional

Defaults to now minus 30 days when omitted.

period_endstring <date-time>Optional

Defaults to now when omitted.

Response body

Success response 200 · schema ContractLineApiSuccess

successbooleanRequired

Enum: true

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

timestampstring <date-time>Required

versionstringRequired

Response codes

200

Usage metrics returned.

401

x-api-key missing at middleware.

500

Request context missing or usage query failure.

GET /api/v1/contract-lines/{id}/usage-metrics

cURL

curl -X GET "https://algapsa.com/api/v1/contract-lines/{id}/usage-metrics?period_start=2026-04-18T15%3A22%3A14Z&period_end=2026-04-18T15%3A22%3A14Z" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contract-lines/{id}/usage-metrics?period_start=2026-04-18T15%3A22%3A14Z&period_end=2026-04-18T15%3A22%3A14Z", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/contract-lines/{id}/usage-metrics?period_start=2026-04-18T15%3A22%3A14Z&period_end=2026-04-18T15%3A22%3A14Z");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "success": true,
  "data": {},
  "meta": {
    "timestamp": "2026-04-18T15:22:14Z",
    "version": "string"
  }
}