Download Log as CSV

Get a ZIP of CSV files from the API Call History of a Spark service. This is equivalent to the API Call History functionality to Download all API calls, Download as CSV.

Authorization

• Bearer {token} accessible from Authorization - Bearer token or systematically via Client Credentials.

  • The request headers should include a key for Authorization with the value Bearer {token}.

• API key created from Authorization - API keys. The API key groups must contain User groups that are also assigned to Permissions - Features permissions Spark.DownloadCsvLog.json or Spark.AllEncompassingProxy.json.

  • The request headers should include the keys x-synthetic-key and x-tenant-name with the values of the API key and tenant name respectively.

POST log job

Returns: status response with job_id of the requested job.

POST /{tenant}/api/v3/folders/{folder}/services/{service}/log/downloadcsv

Path parameters

Key	Value
tenant *	Tenant is part of your Log in to Spark URL and also available in the User menu.
folder *	Folder associated with the API call.
service *	Service associated with the API call.

Request body

Content-Type: application/json

Key	Value
request_data.timezone_offset	Number of hours to adjust the returned timestamps.
request_data.start_date	Timestamp for start log time filter. Use Timestamp Converter to convert dates to ISO 8601. Example 1: 2022-10-30 Example 2: 2022-10-30T18:30:00.853Z
request_data.end_date	Timestamp for end log time filter. Use Timestamp Converter to convert dates to ISO 8601. Example 1: 2022-10-30 Example 2: 2022-10-30T18:30:00.853Z
request_data.call_ids	Array containing call_ids, or single element correlation_id, or single element source_system to filter. Example 1: ["329700e6-0850-40cf-b61e-310c2f756b73", fc01d941-bc29-4312-993a-c203913adcb8"] Example 2: ["correlation id for quotation"] Example 3: ["external source system "]
request_data.callpurpose	call_purpose to filter.
request_data.userName	Username to filter. Example: [email protected]
request_data.has_warnings	Boolean to filter calls with warnings. Example: true
request_data.has_errors	Boolean to filter calls with errors. Example: true
request_meta.version_id	version_id to filter for a specific service version. Example: 7c3a51a3-a0ae-41ec-b78a-5b8f75376b2f

Sample request with API key

See How to: Setup a feature permission for guidance in assigning the enable the Authorization - API keys to access Permissions - Features permissionsSpark.DownloadCsvLog.json.

curl --location 'https://excel.myenvironmentname.coherent.global/mytenantname/api/v3/folders/myfoldername/services/myservicename/log/downloadcsv' \
--header 'Content-Type: application/json' \
--header 'x-tenant-name: mytenantname' \
--header 'x-synthetic-key: 5458626120e2' \
--data '{
    "request_data": {
        "start_date": "2023-11-11",
        "end_date": ""
    }
}'

Sample response

HTTP 200 OK Content-Type: application/json

{
    "status": null,
    "response_data": {
        "job_id": "ebcbf840-df82-472a-b9d4-073f14f4320b"
    },
    "response_meta": {
        "service_id": null,
        "version_id": null,
        "version": null,
        "process_time": 0,
        "call_id": null,
        "compiler_version": null,
        "source_hash": null,
        "engine_id": null,
        "correlation_id": null,
        "parameterset_version_id": null,
        "system": "SPARK",
        "request_timestamp": "2023-11-14T07:59:43.050Z"
    },
    "error": null
}

GET log job status

Returns: status response and download_url to download the ZIP file.

GET /{tenant}/api/v3/folders/{folder}/services/{service}/log/downloadcsv/status/{jobId}

Authorization

Follows from Authorization above.

Path parameters

Key	Value
{tenant} *	Tenant is part of your Log in to Spark URL and also available in the User menu.
{folder} *	Folder associated with the API call.
{service} *	Service associated with the API call.
{jobId} *	job_id associated from POST log job.

Sample request with API key

curl --location 'https://excel.myenvironmentname.coherent.global/mytenantname/api/v3/folders/myfoldername/services/myservicename/log/downloadcsv/status/ebcbf840-df82-472a-b9d4-073f14f4320b' \
--header 'x-tenant-name: <mytenantname>' \
--header 'x-synthetic-key: <myapikey>'

Sample response

HTTP 200 OK Content-Type: application/json

{
    "status": null,
    "response_data": {
        "progress": 100,        
        "download_url": "https://environment.coherent.global/SparkService_allRecords_2023_11_14_T_08_25_40.zip"
    },
    "response_meta": {
        "service_id": null,
        "version_id": null,
        "version": null,
        "process_time": 0,
        "call_id": null,
        "compiler_version": null,
        "source_hash": null,
        "engine_id": null,
        "correlation_id": null,
        "parameterset_version_id": null,
        "system": "SPARK",
        "request_timestamp": "2023-11-14T08:25:40.762Z"
    },
    "error": null
}