Create a saved analysis

Production

https://api.belga.press/belgapress/api

POST

/savedanalyses

Creates a new saved analysis. The category field determines which
variant is created:

BELGA - classic news analysis (unchanged from current behaviour)

SENTOMETRICS - sentometrics entity/sector analysis

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://sso.ssl.belga.be/auth/realms/belga/protocol/openid-connect/auth

Token URL: https://sso.ssl.belga.be/auth/realms/belga/protocol/openid-connect/token

Scopes:

offline_access-Offline access

openid-OpenID

profile-Profile

email-Email

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Created

Body

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.belga.press/belgapress/api/savedanalyses' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "description": "string",
    "category": "BELGA",
    "collaboration": {
        "type": "PRIVATE",
        "owners": [
            {
                "userId": 0,
                "firstName": "string",
                "lastName": "string",
                "email": "user@example.com",
                "organizationName": "string"
            }
        ],
        "editors": [
            {
                "userId": 0,
                "firstName": "string",
                "lastName": "string",
                "email": "user@example.com",
                "organizationName": "string"
            }
        ]
    },
    "options": {
        "analysisType": "AUDIENCE_REACHED",
        "chartDisplay": "BAR",
        "comparisonType": "PERIODS",
        "periodComparison": "PREVIOUS_PERIOD_MATCH",
        "datasets": [
            {
                "sourceType": "BOARD",
                "sourceId": "string",
                "sourceName": "string",
                "hexColor": "string",
                "period": {
                    "dateRangeType": "TODAY",
                    "start": "2019-08-24T14:15:22.123Z",
                    "end": "2019-08-24T14:15:22.123Z"
                }
            }
        ],
        "filters": {
            "searchtext": "string",
            "exactquery": true,
            "board": "a98884d6-3c76-4114-ba9c-216527a5aac1",
            "start": "2019-08-24T14:15:22.123Z",
            "end": "2019-08-24T14:15:22.123Z",
            "resolution": "string",
            "language": [
                "string"
            ],
            "sourceid": [
                0
            ],
            "sourcegroupid": [
                0
            ],
            "subsourceid": [
                0
            ],
            "subsourcegroupid": [
                0
            ],
            "mediumtypeid": [
                0
            ],
            "mediumtypegroupid": [
                0
            ],
            "publisher": [
                "string"
            ],
            "authors": [
                "string"
            ],
            "keyword": [
                "string"
            ],
            "editions": [
                "string"
            ],
            "topics": [
                "string"
            ],
            "sentiment": [
                "string"
            ],
            "tagids": [
                0
            ],
            "mustcontain": [
                "string"
            ],
            "excludednewsobjectuuids": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "newsuuid": [
                "string"
            ],
            "collapseduplicates": true,
            "highlight": true,
            "intro": "string",
            "title": "string",
            "pagenr": "string",
            "subscription": true,
            "mediavaluemin": 0,
            "mediavaluemax": 0,
            "wordcountmin": 0,
            "wordcountmax": 0,
            "order": [
                "string"
            ]
        }
    }
}'

Response Example

200 - Example 1

{
    "id": 0,
    "title": "string",
    "description": "string",
    "category": "BELGA",
    "collaboration": {
        "type": "PRIVATE",
        "owners": [
            {
                "userId": 0,
                "firstName": "string",
                "lastName": "string",
                "email": "user@example.com",
                "organizationName": "string"
            }
        ],
        "editors": [
            {
                "userId": 0,
                "firstName": "string",
                "lastName": "string",
                "email": "user@example.com",
                "organizationName": "string"
            }
        ]
    },
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "options": {
        "analysisType": "AUDIENCE_REACHED",
        "chartDisplay": "BAR",
        "comparisonType": "PERIODS",
        "periodComparison": "PREVIOUS_PERIOD_MATCH",
        "datasets": [
            {
                "sourceType": "BOARD",
                "sourceId": "string",
                "sourceName": "string",
                "hexColor": "string",
                "period": {
                    "dateRangeType": "TODAY",
                    "start": "2019-08-24T14:15:22.123Z",
                    "end": "2019-08-24T14:15:22.123Z"
                }
            }
        ],
        "filters": {
            "searchtext": "string",
            "exactquery": true,
            "board": "a98884d6-3c76-4114-ba9c-216527a5aac1",
            "start": "2019-08-24T14:15:22.123Z",
            "end": "2019-08-24T14:15:22.123Z",
            "resolution": "string",
            "language": [
                "string"
            ],
            "sourceid": [
                0
            ],
            "sourcegroupid": [
                0
            ],
            "subsourceid": [
                0
            ],
            "subsourcegroupid": [
                0
            ],
            "mediumtypeid": [
                0
            ],
            "mediumtypegroupid": [
                0
            ],
            "publisher": [
                "string"
            ],
            "authors": [
                "string"
            ],
            "keyword": [
                "string"
            ],
            "editions": [
                "string"
            ],
            "topics": [
                "string"
            ],
            "sentiment": [
                "string"
            ],
            "tagids": [
                0
            ],
            "mustcontain": [
                "string"
            ],
            "excludednewsobjectuuids": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "newsuuid": [
                "string"
            ],
            "collapseduplicates": true,
            "highlight": true,
            "intro": "string",
            "title": "string",
            "pagenr": "string",
            "subscription": true,
            "mediavaluemin": 0,
            "mediavaluemax": 0,
            "wordcountmin": 0,
            "wordcountmax": 0,
            "order": [
                "string"
            ]
        }
    }
}

Modified at 2026-03-31 09:46:21

GET analysis summary

GET analysis of article count over time