Skip to main content
POST
/
v1
/
trackers
Create tracker
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({entityName: '<string>'})
};

fetch('https://api.arcmira.com/v1/trackers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://api.arcmira.com/v1/trackers"

payload = { "entityName": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
curl --request POST \
  --url https://api.arcmira.com/v1/trackers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityName": "<string>"
}
'
{
  "tracker": {
    "id": "<string>",
    "entityName": "<string>",
    "entityType": "<string>",
    "displayName": "<string>",
    "notifyEmail": true,
    "notifyWebhook": true,
    "notifySlack": true,
    "webhookUrl": "<string>",
    "slackChannelId": "<string>",
    "slackIntegrationId": "<string>",
    "filters": {},
    "isPaused": true,
    "pausedAt": "<string>",
    "lastNotifiedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "emailDeliveryCount": 123,
    "webhookDeliveryCount": 123,
    "slackDeliveryCount": 123,
    "monitorId": "<string>"
  },
  "message": "<string>"
}
{
  "tracker": {
    "id": "<string>",
    "entityName": "<string>",
    "entityType": "<string>",
    "displayName": "<string>",
    "notifyEmail": true,
    "notifyWebhook": true,
    "notifySlack": true,
    "webhookUrl": "<string>",
    "slackChannelId": "<string>",
    "slackIntegrationId": "<string>",
    "filters": {},
    "isPaused": true,
    "pausedAt": "<string>",
    "lastNotifiedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "emailDeliveryCount": 123,
    "webhookDeliveryCount": 123,
    "slackDeliveryCount": 123,
    "monitorId": "<string>"
  },
  "message": "<string>"
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
entityName
string
required

The entity name to resolve and watch. Required on create. Creating a duplicate (same name + type) returns 409 with the existingId.

Minimum string length: 1
​
entityType
enum<string>
required

Entity type of the tracked entity. Required on create.

Available options:
person,
organization,
product,
topic,
channel
​
displayName
string

Optional label shown in alerts and the dashboard.

​
notifyEmail
boolean

Per-tracker email delivery. Default true.

​
notifyWebhook
boolean

Per-tracker webhook delivery override. Paid plans only.

​
notifySlack
boolean

Per-tracker Slack delivery override. Paid plans only.

​
webhookUrl
string

Per-tracker webhook destination override (http/https).

​
slackChannelId
string

Per-tracker Slack channel override.

​
slackIntegrationId
string

Per-tracker Slack integration override.

​
filters
object

Optional matching filters, stored and applied at alert time.

​
{key}
any

Response

Success

​
tracker
object
required
​
message
string
required

Human-readable confirmation.