---
title: /v2/insights
slug: ab-7039/7q5K-v2insights
createdAt: 2026-10-15T11:36:16.857Z
---
{
"id": "vrcXl2dxANlAc2kBHmGvE",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://dev-api.cloudzero.com/v2/insights",
"servers": [
{
"url": "https://dev-api.cloudzero.com/v2/insights"
}
],
"name": "",
"description": "Create a new Insight",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "optional",
"name": "cloudzero-idempotency-key",
"type": "string",
"description": "If passed, any subsequent operation with the same value for this header will return the exact same result.\nThis is true for all responses, i.e. successes and errors.
"
},
{
"kind": "optional",
"name": "cloudzero-test-key",
"type": "string",
"description": "If passed, the operation executes in the namespace specified by this key.\nResource mutations in the namespace last for 1 hour.
"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"customType": "insight_new",
"schema": [
{
"name": "effort",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"not_set",
"low",
"medium",
"high"
]
},
{
"name": "cost_impact",
"kind": "optional",
"type": "object",
"description": "String or float representation of a dollar amount",
"modelRef": "#/components/schemas/currency_in",
"customType": "currency_in",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "currency",
"description": "",
"modelRef": "#/components/schemas/currency",
"schema": []
},
{
"name": "object",
"description": "",
"schema": []
}
]
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"new",
"in_progress",
"on_hold",
"addressed",
"ignored"
]
},
{
"name": "category",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "link",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "title",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/insight_new",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "APIKeyAuth",
"name": "Authorization",
"kind": "optional",
"type": "apiKey",
"in": "header"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful Operation",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "insight",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/insight",
"customType": "insight",
"schema": [],
"complexType": "allOf",
"complexItems": [
{
"name": "insight_new",
"description": "",
"modelRef": "#/components/schemas/insight_new",
"schema": [
{
"name": "effort",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"not_set",
"low",
"medium",
"high"
]
},
{
"name": "cost_impact",
"kind": "optional",
"type": "object",
"description": "String or float representation of a dollar amount",
"modelRef": "#/components/schemas/currency_in",
"customType": "currency_in",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "currency",
"description": "",
"modelRef": "#/components/schemas/currency",
"schema": []
},
{
"name": "object",
"description": "",
"schema": []
}
]
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"new",
"in_progress",
"on_hold",
"addressed",
"ignored"
]
},
{
"name": "category",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "link",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "title",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "with_id",
"description": "",
"modelRef": "#/components/schemas/with_id",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": ""
}
]
},
{
"name": "with_created",
"description": "",
"modelRef": "#/components/schemas/with_created",
"schema": [
{
"name": "created",
"kind": "required",
"type": "string",
"description": "UTC timestamp for the creation of this entity",
"modelRef": "#/components/schemas/epoch",
"customType": "epoch",
"schema": []
}
]
},
{
"name": "with_last_updated",
"description": "",
"modelRef": "#/components/schemas/with_last_updated",
"schema": [
{
"name": "last_updated",
"kind": "required",
"type": "string",
"description": "UTC timestamp for the last update of this entity",
"modelRef": "#/components/schemas/epoch",
"customType": "epoch",
"schema": []
}
]
},
{
"name": "object",
"description": "",
"schema": [
{
"name": "cost_impact",
"kind": "optional",
"type": "string",
"description": "String representation of a dollar amount",
"modelRef": "#/components/schemas/currency",
"customType": "currency",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad Request Error",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "error",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/error",
"customType": "error",
"schema": [
{
"name": "message",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "type",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
],
"isExpanded": true
}
]
},
{
"statusCode": "403",
"description": "Forbidden",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "message",
"kind": "required",
"type": "string",
"description": ""
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://dev-api.cloudzero.com/v2/insights \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"cost_impact\": {}\n }'"
},
{
"id": "example-1-javascript",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"cost_impact\": {}\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://dev-api.cloudzero.com/v2/insights\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "example-2-ruby",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://dev-api.cloudzero.com/v2/insights\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"cost_impact\": {}\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "example-3-python",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://dev-api.cloudzero.com/v2/insights\"\n\npayload = json.dumps({\n \"cost_impact\": {}\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Successful Operation\n{\n \"insight\": {}\n}"
},
{
"id": "response-1-400",
"language": "400",
"code": "// Bad Request Error\n{\n \"error\": {\n \"message\": \"\",\n \"type\": \"\"\n }\n}"
},
{
"id": "response-2-403",
"language": "403",
"code": "// Forbidden\n{\n \"message\": \"\"\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"text": ""
}
]
}