Get ReportSubscription | Solvimon

curl https://test.api.solvimon.com/v1/report-subscriptions/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "id": "a3f47b2e-9c4d-4f1a-8b2e-7d9f3c1a2b4e",
  "report_configuration_id": "d2e5f7a1-3b4c-4d5e-8f6a-7b8c9d0e1f2a",
  "report_code": "INV_SUMMARY_2024",
  "format": "CSV",
  "trigger": "INVOICE_TO_FINAL",
  "schedule": {
    "time_of_day": 14,
    "day_of_week": "MONDAY",
    "day_of_month": 1
  },
  "active": true,
  "export_location": {
    "integration_id": "intg-987654321",
    "variant": "BIGQUERY",
    "stream_name": "invoice_reports_stream",
    "bigquery": {
      "dataset_id": "finance_reports_dataset"
    },
    "s3": {
      "bucket_path": "s3://company-reports/invoices/",
      "path_format": "year=2024/month=04/day=01/",
      "format_type": "CSV"
    },
    "gcs": {
      "bucket_path": "gs://company-reports/invoices/",
      "path_format": "year=2024/month=04/day=01/",
      "format_type": "CSV"
    }
  },
  "parameter_values": [
    {
      "name": "report_date",
      "value": "2024-04-01"
    }
  ]
}

Requires the REPORT_SUBSCRIPTION.VIEW 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

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

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

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors