Nuvelics documentation
APIAPI reference

Dashboard

Read everything your organization's dashboard shows in one call: top pitches, the pitch backlog, story activity, data source health and what needs attention.

GET
/api/tenant/v1/dashboard

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Query Parameters

newsdeskId?string

Newsdesk identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
createdAfter*string

ISO 8601 cutoff; only rows at or after this instant are counted or listed

Formatdate-time

Response Body

The org dashboard's combined tile data

application/json
  1. response
pitchBacklog*

Pitch counts by editorial status, within the filtered scope

topPitches*array<>

The newsdesk's highest-ranked pitches

storyActivity*

The recent-stories tile: an enriched-story count plus a recently-updated list

datasourceHealth*

The datasource-health tile. Always org-wide, never newsdesk-scoped

attentionRollup*

The needs-attention rollup: unreviewed pitches by newsdesk and by topic

Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/dashboard?createdAfter=2019-08-24T14%3A15%3A22Z'
Example Response
{  "pitchBacklog": {    "new": 0,    "approved": 0,    "dismissed": 0  },  "topPitches": [    {      "id": "string",      "orgId": "string",      "newsdeskId": "string",      "eventClusterId": "string",      "title": "string",      "summary": "string",      "whyItMatters": "string",      "score": 0,      "contentLanguage": "string",      "eventDate": "2019-08-24",      "status": "draft",      "creationSource": "auto",      "statusChangedAt": "2019-08-24T14:15:22Z",      "statusChangedBy": "string",      "createdBy": "string",      "manualRequestId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "storyId": "string"    }  ],  "storyActivity": {    "enrichedCount": 0,    "recent": [      {        "id": "string",        "orgId": "string",        "source": "pitch",        "newsdeskId": "string",        "pitchId": "string",        "title": "string",        "summary": "string",        "whyItMatters": "string",        "contentLanguage": "string",        "enrichmentStatus": "pending",        "enrichmentAttempts": 0,        "lastEnrichmentError": "string",        "origin": "string",        "nrcsDropped": "archived",        "enrichedContentSha": "string",        "storyType": "PLANNED",        "lifecyclePhase": "DEVELOPING",        "phaseEnteredAt": "2019-08-24T14:15:22Z",        "sequenceNumber": 0,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ]  },  "datasourceHealth": {    "stalledCount": 0  },  "attentionRollup": {    "total": 0,    "byNewsdesk": [      {        "newsdeskId": "string",        "count": 0      }    ],    "byTopic": {      "values": [        {          "value": "string",          "count": 0        }      ],      "capped": true    }  }}

Report a problem with this page

On this page