Create a report subscription | Solvimon

curl -X POST https://test.api.solvimon.com/v1/report-subscriptions \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "report_configuration_id": "rcf-9a8b7c6d5e4f3g2h1i0j",
  "format": "CSV",
  "active": true,
  "parameter_values": [
    {
      "name": "report_date",
      "value": "2024-05-01"
    }
  ]
}'

{
  "report_configuration_id": "rcf-9a8b7c6d5e4f3g2h1i0j",
  "format": "CSV",
  "active": true,
  "parameter_values": [
    {
      "name": "report_date",
      "value": "2024-05-01"
    }
  ],
  "id": "rsub-123e4567-e89b-12d3-a456-426614174000",
  "report_code": "INV_FINAL_2024",
  "trigger": "INVOICE_TO_FINAL",
  "schedule": {
    "time_of_day": 14,
    "day_of_week": "MONDAY",
    "day_of_month": 15
  },
  "export_location": {
    "integration_id": "intg-5f4e3d2c1b0a98765432",
    "variant": "BIGQUERY",
    "stream_name": "invoice_final_reports",
    "bigquery": {
      "dataset_id": "billing_data_2024"
    },
    "s3": {
      "bucket_path": "s3://company-reports/invoices",
      "path_format": "year=2024/month=05/day=01",
      "format_type": "CSV"
    },
    "gcs": {
      "bucket_path": "gs://company-reports/invoices",
      "path_format": "year=2024/month=05/day=01",
      "format_type": "CSV"
    }
  }
}

Requires the REPORT_SUBSCRIPTION.CREATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Request

This endpoint expects an object.

report_configuration_idstringRequired

Resource ID of type REPORT_CONFIGURATION

formatenumRequired

Allowed values:

activebooleanRequired

parameter_valueslist of objectsRequired

triggerenum or nullOptional

Allowed values:

scheduleobjectOptional

export_locationobjectOptional

Response

Created

report_configuration_idstring

Resource ID of type REPORT_CONFIGURATION

formatenum

Allowed values:

activeboolean

parameter_valueslist of objects

idstring or nullRead-only

report_codestring or nullRead-only

triggerenum or null

Allowed values:

scheduleobject

export_locationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors