Skip to main content
POST
/
api
/
v1
/
report-templates
CreateReportTemplate
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/report-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "clientKey": "<string>",
  "description": "<string>",
  "tagNames": [
    "<string>"
  ],
  "organizationId": "<string>",
  "ruleIds": {
    "ruleIds": [
      "<string>"
    ]
  },
  "ruleClientKeys": {
    "ruleClientKeys": [
      "<string>"
    ]
  },
  "metadata": [
    {
      "key": {
        "name": "<string>",
        "type": "METADATA_KEY_TYPE_UNSPECIFIED",
        "archivedDate": "2023-11-07T05:31:56Z"
      },
      "stringValue": "<string>",
      "numberValue": 123,
      "booleanValue": true,
      "archivedDate": "2023-11-07T05:31:56Z"
    }
  ]
}'
{
  "reportTemplate": {
    "reportTemplateId": "<string>",
    "organizationId": "<string>",
    "clientKey": "<string>",
    "name": "<string>",
    "description": "<string>",
    "archivedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "rules": [
      {
        "ruleId": "<string>",
        "ruleVersionId": "<string>",
        "ruleVersionNumber": 123,
        "clientKey": "<string>"
      }
    ],
    "tags": [
      {
        "tagName": "<string>"
      }
    ],
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json

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

name
string
required
tagNames
string[]
required
clientKey
string
description
string
organizationId
string
ruleIds
object
ruleClientKeys
object
metadata
object[]

Response

A successful response.

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

reportTemplate
object
required