Create a goal

Updated:

POST/performance/{connection_id}/goal

Creates a PerformanceGoal. Provide the unified PerformanceGoal fields in the request body; they are mapped to the provider's API. Returns the created PerformanceGoal.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Payload

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
descriptionstring
user_idsstring array
HR Employees that own or share this goal; the first element is the primary owner
company_idstring
parent_idstring
id of the parent goal, for goal alignment / OKR trees
cycle_idstring
pointer to the Performance Cycle object (goal cycle or timeframe)
type enum
Valid values:
"INDIVIDUAL"
"TEAM"
"DEPARTMENT"
"COMPANY"
"OTHER"
status enum
Valid values:
"NOT_STARTED"
"IN_PROGRESS"
"COMPLETED"
"CLOSED"
"OTHER"
progressnumber
progress percentage from 0 to 100
weightnumber
the weight of this goal when the provider weighs goals in reviews
start_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
due_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
completed_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
milestones array
milestones or key results for this goal
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
descriptionstringNo
user_idsstring[]NoHR Employees that own or share this goal; the first element is the primary owner
company_idstringNo
parent_idstringNoid of the parent goal, for goal alignment / OKR trees
cycle_idstringNopointer to the Performance Cycle object (goal cycle or timeframe)
typeenumNoValues: INDIVIDUAL, TEAM, DEPARTMENT, COMPANY, OTHER
statusenumNoValues: NOT_STARTED, IN_PROGRESS, COMPLETED, CLOSED, OTHER
progressnumberNoprogress percentage from 0 to 100
weightnumberNothe weight of this goal when the provider weighs goals in reviews
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
completed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
milestonesPerformanceGoalMilestone[]Nomilestones or key results for this goal
milestones[].idstringNo
milestones[].namestringYes
milestones[].descriptionstringNo
milestones[].target_valuenumberNo
milestones[].current_valuenumberNo
milestones[].unitstringNounit of the target/current values (e.g. %, USD, count)
milestones[].weightnumberNo
milestones[].is_completedbooleanNo
milestones[].due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadataPerformanceMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'POST',
  url: 'https://api.unified.to/performance/5de520f96e439b002043d8dc/goal',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?