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-9a8b7c6d5e4f3a2b1c0d"
}'

{
  "object_type": "REPORT_SUBSCRIPTION",
  "id": "rsub-123e4567-e89b-12d3-a456-426614174000",
  "report_configuration_id": "rcf-9a8b7c6d5e4f3a2b1c0d",
  "report_code": "MONTHLY_USAGE",
  "format": "CSV",
  "trigger": "INVOICE_TO_FINAL",
  "schedule": {
    "time_of_day": 14,
    "day_of_week": "MONDAY",
    "day_of_month": 15
  },
  "active": true,
  "export_location": {
    "integration_id": "intg-5f4e3d2c1b0a98765432",
    "variant": "BIGQUERY",
    "stream_name": "monthly_usage_stream",
    "bigquery": {
      "dataset_id": "billing_reports_dataset"
    },
    "s3": {
      "bucket_path": "s3://company-reports/monthly",
      "path_format": "yyyy/MM/dd",
      "format_type": "CSV"
    },
    "gcs": {
      "bucket_path": "gs://company-reports/monthly",
      "path_format": "yyyy/MM/dd",
      "format_type": "CSV"
    }
  },
  "parameter_values": [
    {
      "name": "report_date",
      "value": "2024-06-01"
    }
  ]
}

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

Headers

x-platform-idstringOptional

Platform ID.

Request

This endpoint expects an object.

report_configuration_idstringRequired

Resource ID of type REPORT_CONFIGURATION

formatenumOptional

Allowed values:

triggerenum or nullOptional

Allowed values:

scheduleobjectOptional

activebooleanOptional

export_locationobjectOptional

parameter_valueslist of objectsOptional

Response

Created

object_typestring or nullRead-only

idstring or nullRead-only

report_configuration_idstring

Resource ID of type REPORT_CONFIGURATION

report_codestring or nullRead-only

formatenum

Allowed values:

triggerenum or null

Allowed values:

scheduleobject

activeboolean

export_locationobject

parameter_valueslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error