Datafor

Appearance

Execute an alert

About 781 wordsAbout 3 min

apiAlert

Method
POST

Request URL

/plugin/datafor/api/alert/execute

Authorization
Use of this API requires authentication. For details about the authentication method, see
Authorization.

Content Type
application/json

Preconditions

  • The current user must have read privileges for the alert.

Request Example

{
  "pagePath": "/public/test.datafor",
  "componentId": "C739239F-4B54-6C90-8389-BF77F713AA98",
  "componentTitle": "Business Overview",
  "enabled": "1",
  "name": "Test Alert",
  "title": "",
  "rule": {
    "logical": "and",
    "conditions": [
      {
        "id": "sales_fact.store_sales.1717310261398",
        "uniqueName": "[Measures].[store_sales]",
        "comparator": ">=",
        "value": [1],
        "match": "any"
      }
    ]
  },
  "qm": {
    "queryModel": {
      "axes": {
        "FILTER": {
          "mdx": null,
          "filters": [],
          "sortOrder": null,
          "sortEvaluationLiteral": null,
          "hierarchizeMode": null,
          "location": "FILTER",
          "hierarchies": [
            {
              "name": "[time_by_day].[AGG_the_date]",
              "levels": {
                "the_date@@MONTHS": {
                  "name": "the_date@@MONTHS",
                  "caption": "the_date(Month)",
                  "mdx": null,
                  "selection": {
                    "type": "INCLUSION",
                    "members": "[Object]",
                    "parameterName": null
                  },
                  "aggregators": [],
                  "filters": []
                }
              },
              "cmembers": {},
              "schema": "workshop-model",
              "cube": "workshop-model",
              "id": "UUID-344F5E34-451E-BB1A-B991-2D4192646E1B"
            }
          ],
          "nonEmpty": false
        },
        "COLUMNS": {
          "mdx": null,
          "filters": [],
          "sortOrder": null,
          "filterAxis": false,
          "sortEvaluationLiteral": null,
          "hierarchizeMode": null,
          "location": "COLUMNS",
          "hierarchies": [],
          "nonEmpty": true
        },
        "ROWS": {
          "mdx": null,
          "filters": [],
          "sortOrder": null,
          "sortEvaluationLiteral": null,
          "hierarchizeMode": null,
          "location": "ROWS",
          "hierarchies": [
            {
              "name": "[product_class].[hierarchy_product_family1]",
              "levels": {
                "product_family": {
                  "name": "product_family",
                  "caption": "product_family",
                  "mdx": null,
                  "selection": {},
                  "aggregators": [],
                  "filters": [],
                  "sort": 1
                }
              },
              "cmembers": {},
              "filters": []
            }
          ],
          "nonEmpty": true
        }
      },
      "visualTotals": false,
      "visualTotalsPattern": null,
      "lowestLevelsOnly": false,
      "details": {
        "axis": "COLUMNS",
        "location": "BOTTOM",
        "measures": [
          {
            "caption": "store_sales",
            "name": "sales_fact.store_sales",
            "uniqueName": "[Measures].[sales_fact.store_sales]",
            "id": "sales_fact.store_sales.1717310261398",
            "type": "EXACT",
            "sort": 2
          }
        ]
      },
      "calculatedMeasures": [],
      "calculatedMembers": []
    },
    "queryType": "OLAP",
    "properties": {
      "datafor.query.pick.row": "0,5000",
      "datafor.secret.appKey": "",
      "datafor.olap.result.formatter": "mix",
      "datafor.client.timezone": "Australia/Melbourne",
      "datafor.client.locale": "en",
      "datafor.source.format": "true"
    },
    "parameters": {},
    "plugins": {},
    "mdx": null,
    "name": "C739239F-4B54-6C90-8389-BF77F713AA98",
    "metadata": {},
    "type": "QUERYMODEL",
    "cube": {
      "uniqueName": "[workshop-model].[workshop-model].[workshop-model].[workshop-model]",
      "name": "workshop-model",
      "connection": "workshop-model",
      "catalog": "workshop-model",
      "schema": "workshop-model",
      "caption": "workshop-model",
      "visible": true
    }
  },
  "cron": {
    "complexJobTrigger": {
      "endTime": null,
      "startTime": "2024-08-07T12:00:00.000+08:00",
      "uiPassParam": "WEEKLY",
      "daysOfWeek": ["0"]
    }
  },
  "channels": ["email"],
  "emailConfig": {
    "toUsers": ["admin", "peter"],
    "ccUsers": ["sally"],
    "bccUsers": ["linda"],
    "subject": "Subject",
    "content": "Rich text content or plain text content ${value}"
  }
}

Parameters Schema

NameLocationTypeRequiredDescription
bodybodyobjectNoOverall JSON payload
├── pagePathbodystringNoFull path of the page (e.g., /public/test.datafor)
├── componentIdbodystringNoComponent identifier
├── componentTitlebodystringNoComponent title (e.g., "test")
├── enabledbodystringYesWhether alert is enabled: 1 (true) or 0 (false)
├── namebodystringNoAlert name
├── titlebodystringNoAlert title (can be empty)
├── rulebodyobjectYesDefines the alert conditions
│ ├── logicalbodystringYesLogical operator (and / or)
│ └── conditionsbody[object]YesArray of condition objects
│ ├── idbodystringNoUnique condition or measure ID
│ ├── uniqueNamebodystringNoUnique measure identifier
│ ├── comparatorbodystringNoComparison operator (>=, <=, in, not in, etc.)
│ ├── valuebody[integer]NoNumeric threshold(s) for the comparator
│ └── matchbodystringNoany or all (default: any)
├── qmbodyobjectYesQuery configuration wrapper
│ ├── queryModelbodyobjectYesDefines the axes, measures, etc.
│ │ ├── axesbodyobjectYesObject containing FILTER, COLUMNS, ROWS
│ │ │ ├── FILTERbodyobjectYesFilter axis configuration
│ │ │ ├── COLUMNSbodyobjectYesColumns axis configuration
│ │ │ └── ROWSbodyobjectYesRows axis configuration
│ │ ├── visualTotalsbodybooleanYesWhether to enable visual totals
│ │ ├── visualTotalsPatternbodynullYesNot used in this example
│ │ ├── lowestLevelsOnlybodybooleanYesWhether to only show lowest levels of the hierarchy
│ │ ├── detailsbodyobjectYesAdditional detail settings
│ │ ├── calculatedMeasuresbody[string]YesCalculated measure definitions
│ │ ├── calculatedMembersbody[string]YesCalculated member definitions
│ │ ├── queryTypebodystringYesE.g., OLAP
│ │ ├── propertiesbodyobjectYesQuery properties (paging, time zone, etc.)
│ │ ├── parametersbodyobjectYesQuery parameters (empty if none)
│ │ ├── pluginsbodyobjectYesPlugin configuration (empty if none)
│ │ ├── mdxbodynullYesNot used in this example
│ │ ├── namebodystringYesQuery model name (often the same as componentId)
│ │ ├── metadatabodyobjectYesMetadata object
│ │ ├── typebodystringYesE.g., QUERYMODEL
│ │ └── cubebodyobjectYesCube definition (schema, catalog, etc.)
├── cronbodyobjectYesScheduling configuration
│ └── complexJobTriggerbodyobjectYesDetailed scheduling settings
│ ├── endTimebodynullYesEnd time (null if no end date)
│ ├── startTimebodystringYesStart time (e.g., 2024-08-07T12:00:00.000+08:00)
│ ├── uiPassParambodystringYesScheduling frequency (e.g., WEEKLY)
│ └── daysOfWeekbody[string]YesDays of the week for scheduling (e.g., ["0"] for Sunday)
├── channelsbody[string]YesAlert channels (e.g., [ "email" ])
└── emailConfigbodyobjectYesEmail alert configuration
├── toUsersbody[string]YesEmail recipients (usernames)
├── ccUsersbody[string]YesCC recipients
├── bccUsersbody[string]YesBCC recipients
├── subjectbodystringYesEmail subject (e.g., "alert1")
└── contentbodystringYesEmail body (rich or plain text)

Response Examples

{
  "msg": "success",
  "success": true
}

HTTP Responses

HTTP Status CodeMeaningDescriptionData schema
200OKnoneInline

Response Data Schema (HTTP 200)

NameTypeRequiredDescription
msgstringNoMessage string
successbooleanYesRequest status
Datafor Documentation
Copyright ©2025 Datafor All rights reserved.