API DocsRESTReport template service

CreateReportTemplate

Create a report template.

POST
/api/v1/report-templates

Request Body

application/jsonRequired

The request of a call to ReportTemplateService_CreateReportTemplate to create a report template.

name
Required
string

clientKeystring

descriptionstring

tagNames
Required
array<string>

organizationId`organization_id` is only required if your user belongs to multiple organizations

ruleIdsobject

ruleClientKeysobject

curl -X POST "<API_URL>/api/v1/report-templates" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "clientKey": "string",
    "description": "string",
    "tagNames": [
      "string"
    ],
    "organizationId": "string",
    "ruleIds": {
      "ruleIds": [
        "string"
      ]
    },
    "ruleClientKeys": {
      "ruleClientKeys": [
        "string"
      ]
    }
  }'

A successful response.

{
  "reportTemplate": {
    "reportTemplateId": "string",
    "organizationId": "string",
    "clientKey": "string",
    "name": "string",
    "description": "string",
    "archivedDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "rules": [
      {
        "ruleId": "string",
        "ruleVersionId": "string",
        "ruleVersionNumber": 0,
        "clientKey": "string"
      }
    ],
    "tags": [
      {
        "tagName": "string"
      }
    ]
  }
}

Previous

RerunReport POST

Next

GetReportTemplate GET