Download session report pdf


API Documentation for Session Reports Generation

Endpoint

POST /v2/pipelines/session-reports

This endpoint generates reports for specified session IDs, allowing users to download them in the requested file format.

HTTP Request

POST https://api.satschel.com/v2/pipelines/session-reports

Headers

HeaderValueDescription
Acceptapplication/json, text/plain, /Specifies the media type(s) that is/are acceptable for the response.
AuthorizationBearer {{accessToken}}Uses a bearer token for authorization. Replace {{accessToken}} with the actual access token.

Request Body

The request body must be a JSON object that includes the following fields:

  • sessionIds (array of strings): Array containing the IDs of sessions for which the reports are to be generated.
  • fileType (string): The format of the file to generate. Currently supports "pdf".

Example Request Body

{
    "sessionIds": [
        "661dae73748bcb30dccbe5be"
    ],
    "fileType": "pdf"
}

Responses

200 OK

The report is successfully generated and the URL for downloading the report is provided.

Body:

{
    "message": "ok",
    "data": {
        "url": [
            "https://storage.googleapis.com/.../..."
        ]
    }
}

Notes

  • Ensure that accessToken is replaced with a valid token before making the request.
  • The server needs to handle different file types as specified by the client in the fileType field of the request.