sites

Create Goal

Create a goal. The baseline is measured here, never taken from the caller.

post/sites/{site_id}/goals

Request

  • Base URL: https://api.xeorank.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.xeorank.com/sites/{site_id}/goals
  • Auth: API key in header X-Agent-Key

Path parameters

site_idstring required

Query parameters

emailstring nullable

Request body

titlestring required
descriptionstring nullable
parent_idstring nullable
categorystring
stagestring
prioritystring
tagsstring[] nullable
metric_keystring nullable
directionstring nullable
target_valuenumber nullable
manual_totalinteger nullable
starts_atstring date-time nullable
due_atstring date-time nullable
owner_emailstring nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.