List dataflow reports - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service is used to list the reports that Fluid Topics generates when content is published, updated, or reprocessed.

Information

This web service is available to users or API keys with the ADMIN, KHUB_ADMIN, or CONTENT_PUBLISHER roles.

Depending on the report type, the following information may be available:

  • The date and time the job was launched.
  • Paths to the content that was published or updated.
  • The editorialType of the content that was published or updated.
  • The number of files processed correctly.
  • The number of files processed with errors.
  • The number of rejected files.
  • The duration of the job.
  • The name of the user who launched the job.
Method Endpoint
GET /api/admin/khub/dataflow/reports

It is possible to filter the list of reports by date by using the ?since parameter, as illustrated in the following table:

Method Endpoint
GET /api/admin/khub/dataflow/reports?since=2023-06-17T09:45:12+0000

The since parameter follows the ISO 8601 time format. It accepts three date formats: 2022-12-03T10:15:30, 2022-12-03T10:15:30Z, and 2022-12-03T10:15:30+1000.

When using a time zone offset (for example, +1000, which is Coordinated Universal Time + 10 hours), users must replace the plus sign (+) by %2B.

Response body

[
    {
        "id": "0ca262904cb74244aaf6a95b86f3bb3e",
        "date": "2023-06-15T13:27:02.785+0000",
        "mode": "INCREMENTAL",
        "reportApiEndpoint": "/api/admin/khub/dataflow/reports/0ca262904cb74244aaf6a95b86f3bb3e"
    },
    {
        "id": "d5d519a92e8942738b756936c41f0fcd",
        "date": "2023-06-15T14:03:14.698+0000",
        "mode": "FULL",
        "reportApiEndpoint": "/api/admin/khub/dataflow/reports/d5d519a92e8942738b756936c41f0fcd"
    }
]
Field Type Description
id String The identifier of the dataflow report.
date String The date of the PaF run. It follows a specific format.
mode String The mode of the PaF run (INCREMENTAL or FULL).
reportApiEndpoint String The path where details about a specific report are available.
  • Authentication via the header is required in all calls to Fluid Topics dataflow web services.
  • The first processing job launched after reprocessing may take more time than all other processing jobs.