Skip to main content
POST
/
organisations
/
{orgId}
/
workspaces
/
{workspaceId}
/
outcomes
Create a new goal
curl --request POST \
  --url https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/outcomes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Increase User Engagement",
  "description": "We aim to increase daily active users by 25% in Q3",
  "priority": 1,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "trend": 0,
  "analyticEvents": [
    "event1",
    "event2"
  ],
  "ownerId": "7b9e5d2c-f314-48a9-be56-9843a2f6c019",
  "opportunityIds": [
    "<string>"
  ],
  "metricIds": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "7b9e5d2c-f314-48a9-be56-9843a2f6c019",
    "title": "Increase User Engagement",
    "description": "We aim to increase daily active users by 25% in Q3",
    "priority": 1,
    "hideContent": false,
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "opportunities": [],
    "solutions": [],
    "insights": [],
    "metrics": [],
    "trend": 0,
    "analyticEvents": [
      "event1",
      "event2"
    ],
    "ownerId": "7b9e5d2c-f314-48a9-be56-9843a2f6c019"
  }
}

Authorizations

​
Authorization
string
header
required

JWT authentication for organization-scoped endpoints.

Path Parameters

​
orgId
string
required

Organization ID

​
workspaceId
string
required

Workspace ID

Body

application/json

Request schema for creating an outcome

​
title
string
required

Title of the outcome

Example:

"Increase User Engagement"

​
description
string
required

Detailed description of the outcome

Example:

"We aim to increase daily active users by 25% in Q3"

​
priority
number
required

Priority level of the outcome

Example:

1

​
id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
trend
number

Trend indicator for the outcome

Example:

0

​
analyticEvents
string[]

List of analytic events associated with the outcome

Example:
["event1", "event2"]
​
ownerId
string

ID of the owner of the outcome

Example:

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

​
opportunityIds
string[]
​
metricIds
string[]

Response

Success

Response containing a single outcome

​
data
object
required

Outcome with relationships