Update a metric - Squad AI Documentation

Update a metric

curl --request PUT \
  --url https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Daily Active Users",
  "description": "Number of unique users who performed any action in the last 24 hours",
  "unit": "users",
  "type": "custom",
  "targetValue": 100,
  "targetDirection": "up",
  "currentValue": 150,
  "previousValue": 140,
  "periodType": "calendar",
  "periodValue": "month",
  "ownerId": "user_123456789",
  "timeseries": [
    {
      "date": "2023-11-07T05:31:56Z",
      "value": 85
    }
  ],
  "relatedOutcomes": [
    "<unknown>"
  ],
  "outcomeIds": [
    "7b9e5d2c-f314-48a9-be56-9843a2f6c019"
  ]
}
'

import requests

url = "https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}"

payload = {
    "title": "Daily Active Users",
    "description": "Number of unique users who performed any action in the last 24 hours",
    "unit": "users",
    "type": "custom",
    "targetValue": 100,
    "targetDirection": "up",
    "currentValue": 150,
    "previousValue": 140,
    "periodType": "calendar",
    "periodValue": "month",
    "ownerId": "user_123456789",
    "timeseries": [
        {
            "date": "2023-11-07T05:31:56Z",
            "value": 85
        }
    ],
    "relatedOutcomes": ["<unknown>"],
    "outcomeIds": ["7b9e5d2c-f314-48a9-be56-9843a2f6c019"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'Daily Active Users',
    description: 'Number of unique users who performed any action in the last 24 hours',
    unit: 'users',
    type: 'custom',
    targetValue: 100,
    targetDirection: 'up',
    currentValue: 150,
    previousValue: 140,
    periodType: 'calendar',
    periodValue: 'month',
    ownerId: 'user_123456789',
    timeseries: [{date: '2023-11-07T05:31:56Z', value: 85}],
    relatedOutcomes: ['<unknown>'],
    outcomeIds: ['7b9e5d2c-f314-48a9-be56-9843a2f6c019']
  })
};

fetch('https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Daily Active Users',
    'description' => 'Number of unique users who performed any action in the last 24 hours',
    'unit' => 'users',
    'type' => 'custom',
    'targetValue' => 100,
    'targetDirection' => 'up',
    'currentValue' => 150,
    'previousValue' => 140,
    'periodType' => 'calendar',
    'periodValue' => 'month',
    'ownerId' => 'user_123456789',
    'timeseries' => [
        [
                'date' => '2023-11-07T05:31:56Z',
                'value' => 85
        ]
    ],
    'relatedOutcomes' => [
        '<unknown>'
    ],
    'outcomeIds' => [
        '7b9e5d2c-f314-48a9-be56-9843a2f6c019'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}"

	payload := strings.NewReader("{\n  \"title\": \"Daily Active Users\",\n  \"description\": \"Number of unique users who performed any action in the last 24 hours\",\n  \"unit\": \"users\",\n  \"type\": \"custom\",\n  \"targetValue\": 100,\n  \"targetDirection\": \"up\",\n  \"currentValue\": 150,\n  \"previousValue\": 140,\n  \"periodType\": \"calendar\",\n  \"periodValue\": \"month\",\n  \"ownerId\": \"user_123456789\",\n  \"timeseries\": [\n    {\n      \"date\": \"2023-11-07T05:31:56Z\",\n      \"value\": 85\n    }\n  ],\n  \"relatedOutcomes\": [\n    \"<unknown>\"\n  ],\n  \"outcomeIds\": [\n    \"7b9e5d2c-f314-48a9-be56-9843a2f6c019\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Daily Active Users\",\n  \"description\": \"Number of unique users who performed any action in the last 24 hours\",\n  \"unit\": \"users\",\n  \"type\": \"custom\",\n  \"targetValue\": 100,\n  \"targetDirection\": \"up\",\n  \"currentValue\": 150,\n  \"previousValue\": 140,\n  \"periodType\": \"calendar\",\n  \"periodValue\": \"month\",\n  \"ownerId\": \"user_123456789\",\n  \"timeseries\": [\n    {\n      \"date\": \"2023-11-07T05:31:56Z\",\n      \"value\": 85\n    }\n  ],\n  \"relatedOutcomes\": [\n    \"<unknown>\"\n  ],\n  \"outcomeIds\": [\n    \"7b9e5d2c-f314-48a9-be56-9843a2f6c019\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Daily Active Users\",\n  \"description\": \"Number of unique users who performed any action in the last 24 hours\",\n  \"unit\": \"users\",\n  \"type\": \"custom\",\n  \"targetValue\": 100,\n  \"targetDirection\": \"up\",\n  \"currentValue\": 150,\n  \"previousValue\": 140,\n  \"periodType\": \"calendar\",\n  \"periodValue\": \"month\",\n  \"ownerId\": \"user_123456789\",\n  \"timeseries\": [\n    {\n      \"date\": \"2023-11-07T05:31:56Z\",\n      \"value\": 85\n    }\n  ],\n  \"relatedOutcomes\": [\n    \"<unknown>\"\n  ],\n  \"outcomeIds\": [\n    \"7b9e5d2c-f314-48a9-be56-9843a2f6c019\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "7b9e5d2c-f314-48a9-be56-9843a2f6c019",
    "title": "Daily Active Users",
    "ownerId": "user_123456789",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "description": "Number of unique users who performed any action in the last 24 hours",
    "unit": "users",
    "type": "custom",
    "targetValue": 100,
    "targetDirection": "up",
    "currentValue": 150,
    "previousValue": 140,
    "periodType": "calendar",
    "periodValue": "month",
    "timeseries": [
      {
        "date": "2023-11-07T05:31:56Z",
        "value": 85
      }
    ],
    "relatedOutcomes": [
      "<unknown>"
    ]
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "description": "One or more fields are invalid",
    "fields": [
      "title",
      "description"
    ],
    "validationErrors": {
      "invalidFields": {
        "title": {
          "type": "too_small",
          "message": "Title must be at least 3 characters long",
          "path": [
            "title"
          ]
        },
        "deadline": {
          "type": "invalid_date",
          "message": "Deadline must be a valid date in the future",
          "path": [
            "deadline"
          ]
        }
      }
    }
  }
}

{
  "error": {
    "code": "UNAUTHORISED_ERROR",
    "description": "User is unauthenticated"
  }
}

{
  "error": {
    "code": "UNAUTHORISED_ERROR",
    "description": "User is unauthorised"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "description": "The requested resource was not found"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "description": "An unexpected error occurred on the server"
  }
}

PUT

organisations

{orgId}

workspaces

{workspaceId}

metrics

{MetricId}

Update a metric

curl --request PUT \
  --url https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Daily Active Users",
  "description": "Number of unique users who performed any action in the last 24 hours",
  "unit": "users",
  "type": "custom",
  "targetValue": 100,
  "targetDirection": "up",
  "currentValue": 150,
  "previousValue": 140,
  "periodType": "calendar",
  "periodValue": "month",
  "ownerId": "user_123456789",
  "timeseries": [
    {
      "date": "2023-11-07T05:31:56Z",
      "value": 85
    }
  ],
  "relatedOutcomes": [
    "<unknown>"
  ],
  "outcomeIds": [
    "7b9e5d2c-f314-48a9-be56-9843a2f6c019"
  ]
}
'

import requests

url = "https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}"

payload = {
    "title": "Daily Active Users",
    "description": "Number of unique users who performed any action in the last 24 hours",
    "unit": "users",
    "type": "custom",
    "targetValue": 100,
    "targetDirection": "up",
    "currentValue": 150,
    "previousValue": 140,
    "periodType": "calendar",
    "periodValue": "month",
    "ownerId": "user_123456789",
    "timeseries": [
        {
            "date": "2023-11-07T05:31:56Z",
            "value": 85
        }
    ],
    "relatedOutcomes": ["<unknown>"],
    "outcomeIds": ["7b9e5d2c-f314-48a9-be56-9843a2f6c019"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'Daily Active Users',
    description: 'Number of unique users who performed any action in the last 24 hours',
    unit: 'users',
    type: 'custom',
    targetValue: 100,
    targetDirection: 'up',
    currentValue: 150,
    previousValue: 140,
    periodType: 'calendar',
    periodValue: 'month',
    ownerId: 'user_123456789',
    timeseries: [{date: '2023-11-07T05:31:56Z', value: 85}],
    relatedOutcomes: ['<unknown>'],
    outcomeIds: ['7b9e5d2c-f314-48a9-be56-9843a2f6c019']
  })
};

fetch('https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Daily Active Users',
    'description' => 'Number of unique users who performed any action in the last 24 hours',
    'unit' => 'users',
    'type' => 'custom',
    'targetValue' => 100,
    'targetDirection' => 'up',
    'currentValue' => 150,
    'previousValue' => 140,
    'periodType' => 'calendar',
    'periodValue' => 'month',
    'ownerId' => 'user_123456789',
    'timeseries' => [
        [
                'date' => '2023-11-07T05:31:56Z',
                'value' => 85
        ]
    ],
    'relatedOutcomes' => [
        '<unknown>'
    ],
    'outcomeIds' => [
        '7b9e5d2c-f314-48a9-be56-9843a2f6c019'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}"

	payload := strings.NewReader("{\n  \"title\": \"Daily Active Users\",\n  \"description\": \"Number of unique users who performed any action in the last 24 hours\",\n  \"unit\": \"users\",\n  \"type\": \"custom\",\n  \"targetValue\": 100,\n  \"targetDirection\": \"up\",\n  \"currentValue\": 150,\n  \"previousValue\": 140,\n  \"periodType\": \"calendar\",\n  \"periodValue\": \"month\",\n  \"ownerId\": \"user_123456789\",\n  \"timeseries\": [\n    {\n      \"date\": \"2023-11-07T05:31:56Z\",\n      \"value\": 85\n    }\n  ],\n  \"relatedOutcomes\": [\n    \"<unknown>\"\n  ],\n  \"outcomeIds\": [\n    \"7b9e5d2c-f314-48a9-be56-9843a2f6c019\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Daily Active Users\",\n  \"description\": \"Number of unique users who performed any action in the last 24 hours\",\n  \"unit\": \"users\",\n  \"type\": \"custom\",\n  \"targetValue\": 100,\n  \"targetDirection\": \"up\",\n  \"currentValue\": 150,\n  \"previousValue\": 140,\n  \"periodType\": \"calendar\",\n  \"periodValue\": \"month\",\n  \"ownerId\": \"user_123456789\",\n  \"timeseries\": [\n    {\n      \"date\": \"2023-11-07T05:31:56Z\",\n      \"value\": 85\n    }\n  ],\n  \"relatedOutcomes\": [\n    \"<unknown>\"\n  ],\n  \"outcomeIds\": [\n    \"7b9e5d2c-f314-48a9-be56-9843a2f6c019\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/metrics/{MetricId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Daily Active Users\",\n  \"description\": \"Number of unique users who performed any action in the last 24 hours\",\n  \"unit\": \"users\",\n  \"type\": \"custom\",\n  \"targetValue\": 100,\n  \"targetDirection\": \"up\",\n  \"currentValue\": 150,\n  \"previousValue\": 140,\n  \"periodType\": \"calendar\",\n  \"periodValue\": \"month\",\n  \"ownerId\": \"user_123456789\",\n  \"timeseries\": [\n    {\n      \"date\": \"2023-11-07T05:31:56Z\",\n      \"value\": 85\n    }\n  ],\n  \"relatedOutcomes\": [\n    \"<unknown>\"\n  ],\n  \"outcomeIds\": [\n    \"7b9e5d2c-f314-48a9-be56-9843a2f6c019\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "7b9e5d2c-f314-48a9-be56-9843a2f6c019",
    "title": "Daily Active Users",
    "ownerId": "user_123456789",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "description": "Number of unique users who performed any action in the last 24 hours",
    "unit": "users",
    "type": "custom",
    "targetValue": 100,
    "targetDirection": "up",
    "currentValue": 150,
    "previousValue": 140,
    "periodType": "calendar",
    "periodValue": "month",
    "timeseries": [
      {
        "date": "2023-11-07T05:31:56Z",
        "value": 85
      }
    ],
    "relatedOutcomes": [
      "<unknown>"
    ]
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "description": "One or more fields are invalid",
    "fields": [
      "title",
      "description"
    ],
    "validationErrors": {
      "invalidFields": {
        "title": {
          "type": "too_small",
          "message": "Title must be at least 3 characters long",
          "path": [
            "title"
          ]
        },
        "deadline": {
          "type": "invalid_date",
          "message": "Deadline must be a valid date in the future",
          "path": [
            "deadline"
          ]
        }
      }
    }
  }
}

{
  "error": {
    "code": "UNAUTHORISED_ERROR",
    "description": "User is unauthenticated"
  }
}

{
  "error": {
    "code": "UNAUTHORISED_ERROR",
    "description": "User is unauthorised"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "description": "The requested resource was not found"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "description": "An unexpected error occurred on the server"
  }
}

Authorizations

Authorization

string

header

required

JWT authentication for organization-scoped endpoints.

Path Parameters

orgId

string

required

Organization ID

workspaceId

string

required

Workspace ID

MetricId

string

required

Metric ID

Body

application/json

Request schema for updating an metric

title

string

Display name for the metric

Example:

"Daily Active Users"

description

string

Detailed description of the metric

Example:

"Number of unique users who performed any action in the last 24 hours"

unit

string

Unit of measurement for the metric

Example:

"users"

type

enum<string>

default:custom

Category/type of the metric

Available options:

engagement,

conversion,

revenue,

nps,

csat,

ces,

ratio,

custom

targetOperator

enum<string>

Comparison operator for the target

Available options:

greater_than,

less_than,

equal_to

targetValue

number

Target value to achieve

Example:

100

targetDirection

enum<string>

default:up

Direction of improvement (up = higher is better, down = lower is better)

Available options:

up,

down

currentValue

number

Current value of the metric

Example:

150

previousValue

number

Previous value of the metric for comparison

Example:

140

periodType

enum<string>

Type of period for metric comparison

Available options:

rolling,

calendar

Example:

"calendar"

periodValue

enum<string>

Specific period value for metric comparison

Available options:

day,

week,

month,

quarter,

year,

7-day,

30-day,

90-day

Example:

"month"

ownerId

string

UserId of the Owner/responsible person for this metric

Example:

"user_123456789"

timeseries

object[]

Historical values for trend analysis

Show child attributes

Related outcomes that use this metric

outcomeIds

string[]

Array of outcome IDs to associate with this metric

Example:

["7b9e5d2c-f314-48a9-be56-9843a2f6c019"]

Response

Success

Response containing a single metric

data

object

required

Metric data representing a measurable KPI result

Show child attributes

Get a metric by ID Delete a metric