BizKitHub
DocsAPI ReferenceNewsroom/bff/newsroom/shortlist
getNewsroomAdmin BFF

/bff/newsroom/shortlist

Returns the daily TOP-N candidate articles for the authenticated organisation, ranked by score. Each item exposes scores, source, status and (if generated) draft reference.

NewsroomgetBffNewsroomShortlist

Parameters

3 query

Query parameters

· 3
datestringOptional

YYYY-MM-DD shortlist date filter.

Exampleexample_date
statusstringOptional

Status filter: pending, generating, generated, dismissed.

Exampleexample_status
limitstringOptional

Maximum number of items to return.

Exampleexample_limit

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
shortlistDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
ranknumberRequired
titlestringRequired
sourcestringOptional
sourceUrlstringOptional
feedIdstringOptional

External ID of the source RSS feed.

hotnessScorenumberRequired
czRelevanceScorenumberRequired
cctvFitScorenumberRequired
totalScorenumberRequired
reasonstringOptional
statusstringRequired
draftIdstringOptional
draftStatusstringOptional
topicTypestringOptional
severitystringOptional
insertedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "rank": 0,
      "title": "example_title",
      "source": "example_source",
      "sourceUrl": "example_sourceUrl",
      "feedId": "example_feedId",
      "hotnessScore": 0,
      "czRelevanceScore": 0,
      "cctvFitScore": 0,
      "totalScore": 0,
      "reason": "example_reason",
      "status": "example_status",
      "draftId": "example_draftId",
      "draftStatus": "example_draftStatus",
      "topicType": "example_topicType",
      "severity": "example_severity"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/newsroom/shortlist

get
curl -X GET "https://api.bizkithub.com/bff/newsroom/shortlist?date=example_date&status=example_status&limit=example_limit" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key