dashboard

The methods of pd.dashboard. Inputs and outputs are described in Conventions; every method can also fail as described in Errors.

Methods

pd.dashboard.getAnalytics(input, init?)

Generation and publishing aggregates over a window

GET /api/workspaces/{workspaceId}/analytics

Requires analytics.read. Counts, sums and averages over work already recorded in the last days days; nothing is estimated. A figure with no data behind it is null, not 0. generation covers the generation and translation jobs created in the window; workflow covers review and publishing durations.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.dashboard.getAnalytics({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.dashboard.getTrends(input, init?)

Credits used and articles created or published, per day or week

GET /api/workspaces/{workspaceId}/trends

Requires analytics.read. Every bucket in the window is present, zero when nothing happened. Buckets are UTC days up to 31 days, Monday-starting weeks beyond. credits and operations come from the usage records; articles are counted by creation date and by publishedAt.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.dashboard.getTrends({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.dashboard.getArticleCounts(input, init?)

Article counts by status

GET /api/workspaces/{workspaceId}/article-counts

Requires articles.read. Counts every article of the workspace straight from the database, not capped by list paging: in total, by status, by project, and by status within each project. Absent keys mean zero.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.dashboard.getArticleCounts({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.dashboard.listJobs(input, init?)

Running jobs, and those that failed recently

GET /api/workspaces/{workspaceId}/jobs

Requires articles.read. Returns two lists, each bounded by limit: the generation and translation jobs running now, queued ones included, and the jobs that failed and were created within the last failedWithinDays days. Completed and cancelled jobs are not listed.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.dashboard.listJobs({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.dashboard.listAudit(input, init?)

Audit trail entries, filtered and paged

GET /api/workspaces/{workspaceId}/audit

Requires audit.read. The audit trail records what members, API keys, the system and Stripe did in the workspace; it is append-only and read only here. Entries come newest first, optionally narrowed by exact action, acting user and time window. total counts every matching entry, so pages are walked with limit and offset.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.dashboard.listAudit({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.dashboard.getCreditBurn(input, init?)

Credit consumption over recent days

GET /api/workspaces/{workspaceId}/credit-burn

Requires credits.read. The rate the low-balance warning extrapolates from: the credits charged to generation jobs created in the last days days, divided by the days actually observed. A workspace younger than the window is divided by its age (at least one day), and sufficientHistory is false below three days of history.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.dashboard.getCreditBurn({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);