Get category analytics

Returns category analytics with generation timestamp. Permission resource is chosen dynamically from category_type (defaults to ticket_settings when omitted).

Query parameters

category_typestringOptional

board_idstring <uuid>Optional

date_fromstring <date-time>Optional

date_tostring <date-time>Optional

include_usagestringOptional

Response body

Success response 200 · schema CategoryAnalyticsResponse

dataobjectRequired

analyticsobjectRequired

Aggregated category analytics from CategoryService.getCategoryAnalytics.

generated_atstring <date-time>Required

Response codes

200

Category analytics returned successfully.

400

Invalid query parameters.

401

Authentication failed.

403

Authenticated user lacks the derived settings read permission.

GET /api/v1/categories/analytics

cURL

curl -X GET "https://algapsa.com/api/v1/categories/analytics?category_type=service&board_id=01HN2K7VRB9PQ3Y0000000000&date_from=2026-04-18T15%3A22%3A14Z&date_to=2026-04-18T15%3A22%3A14Z&include_usage=true" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/categories/analytics?category_type=service&board_id=01HN2K7VRB9PQ3Y0000000000&date_from=2026-04-18T15%3A22%3A14Z&date_to=2026-04-18T15%3A22%3A14Z&include_usage=true", {
  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/categories/analytics?category_type=service&board_id=01HN2K7VRB9PQ3Y0000000000&date_from=2026-04-18T15%3A22%3A14Z&date_to=2026-04-18T15%3A22%3A14Z&include_usage=true");
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

{
  "data": {
    "analytics": {},
    "generated_at": "2026-04-18T15:22:14Z"
  }
}