Update an event
curl --request PUT \
--url https://api.example.com/events/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {},
"name": "<string>",
"date": "2023-11-07T05:31:56Z",
"description": "<string>",
"viewUsedForCreation": {
"metricId": "<string>",
"limit": 123,
"groupBy": "<string>",
"from": "<string>",
"to": "<string>",
"previousFrom": "<string>",
"previousTo": "<string>",
"whereClause": {},
"currency": "USD",
"threshold": 123,
"explorerChartType": "BAR",
"bookmarkedEvents": [
"<string>"
],
"eventsFilter": {
"sources": [
"custom",
"api"
],
"githubSourceRepos": [],
"search": ""
},
"scopeId": "<string>"
},
"widgetEvents": [
{
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"request": {
"period": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"forecastDays": 1
},
"queries": [
{
"type": "condition",
"expression": "<string>",
"name": "<string>",
"colorIndex": 123,
"alias": "<string>",
"visible": true
}
],
"bookmarkedEvents": [
"<string>"
],
"eventsFilter": {
"sources": [
"custom",
"api"
],
"githubSourceRepos": [],
"search": ""
},
"scopeId": "<string>",
"limitOverride": 500,
"displayOptions": {
"hideEmptyRows": true,
"topN": 50,
"showTotal": true,
"precision": 3
}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"title": "",
"description": ""
}
],
"id": "<string>",
"metricId": "<string>",
"groupBy": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"conditions": {},
"currency": "USD",
"scopeId": "<string>",
"createdBy": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"tags": []
}
'import requests
url = "https://api.example.com/events/{id}"
payload = {
"metadata": {},
"name": "<string>",
"date": "2023-11-07T05:31:56Z",
"description": "<string>",
"viewUsedForCreation": {
"metricId": "<string>",
"limit": 123,
"groupBy": "<string>",
"from": "<string>",
"to": "<string>",
"previousFrom": "<string>",
"previousTo": "<string>",
"whereClause": {},
"currency": "USD",
"threshold": 123,
"explorerChartType": "BAR",
"bookmarkedEvents": ["<string>"],
"eventsFilter": {
"sources": ["custom", "api"],
"githubSourceRepos": [],
"search": ""
},
"scopeId": "<string>"
},
"widgetEvents": [
{
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"request": {
"period": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"forecastDays": 1
},
"queries": [
{
"type": "condition",
"expression": "<string>",
"name": "<string>",
"colorIndex": 123,
"alias": "<string>",
"visible": True
}
],
"bookmarkedEvents": ["<string>"],
"eventsFilter": {
"sources": ["custom", "api"],
"githubSourceRepos": [],
"search": ""
},
"scopeId": "<string>",
"limitOverride": 500,
"displayOptions": {
"hideEmptyRows": True,
"topN": 50,
"showTotal": True,
"precision": 3
}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"title": "",
"description": ""
}
],
"id": "<string>",
"metricId": "<string>",
"groupBy": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"conditions": {},
"currency": "USD",
"scopeId": "<string>",
"createdBy": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"tags": []
}
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({
metadata: {},
name: '<string>',
date: '2023-11-07T05:31:56Z',
description: '<string>',
viewUsedForCreation: {
metricId: '<string>',
limit: 123,
groupBy: '<string>',
from: '<string>',
to: '<string>',
previousFrom: '<string>',
previousTo: '<string>',
whereClause: {},
currency: 'USD',
threshold: 123,
explorerChartType: 'BAR',
bookmarkedEvents: ['<string>'],
eventsFilter: {sources: ['custom', 'api'], githubSourceRepos: [], search: ''},
scopeId: '<string>'
},
widgetEvents: [
{
x: 123,
y: 123,
w: 123,
h: 123,
request: {
period: {
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
forecastDays: 1
},
queries: [
{
type: 'condition',
expression: '<string>',
name: '<string>',
colorIndex: 123,
alias: '<string>',
visible: true
}
],
bookmarkedEvents: ['<string>'],
eventsFilter: {sources: ['custom', 'api'], githubSourceRepos: [], search: ''},
scopeId: '<string>',
limitOverride: 500,
displayOptions: {hideEmptyRows: true, topN: 50, showTotal: true, precision: 3}
},
id: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedAt: '2023-11-07T05:31:56Z',
title: '',
description: ''
}
],
id: '<string>',
metricId: '<string>',
groupBy: '<string>',
startDate: '<string>',
endDate: '<string>',
conditions: {},
currency: 'USD',
scopeId: '<string>',
createdBy: {id: '<string>', firstName: '<string>', lastName: '<string>'},
tags: []
})
};
fetch('https://api.example.com/events/{id}', 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.example.com/events/{id}",
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([
'metadata' => [
],
'name' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'viewUsedForCreation' => [
'metricId' => '<string>',
'limit' => 123,
'groupBy' => '<string>',
'from' => '<string>',
'to' => '<string>',
'previousFrom' => '<string>',
'previousTo' => '<string>',
'whereClause' => [
],
'currency' => 'USD',
'threshold' => 123,
'explorerChartType' => 'BAR',
'bookmarkedEvents' => [
'<string>'
],
'eventsFilter' => [
'sources' => [
'custom',
'api'
],
'githubSourceRepos' => [
],
'search' => ''
],
'scopeId' => '<string>'
],
'widgetEvents' => [
[
'x' => 123,
'y' => 123,
'w' => 123,
'h' => 123,
'request' => [
'period' => [
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'forecastDays' => 1
],
'queries' => [
[
'type' => 'condition',
'expression' => '<string>',
'name' => '<string>',
'colorIndex' => 123,
'alias' => '<string>',
'visible' => true
]
],
'bookmarkedEvents' => [
'<string>'
],
'eventsFilter' => [
'sources' => [
'custom',
'api'
],
'githubSourceRepos' => [
],
'search' => ''
],
'scopeId' => '<string>',
'limitOverride' => 500,
'displayOptions' => [
'hideEmptyRows' => true,
'topN' => 50,
'showTotal' => true,
'precision' => 3
]
],
'id' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z',
'title' => '',
'description' => ''
]
],
'id' => '<string>',
'metricId' => '<string>',
'groupBy' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'conditions' => [
],
'currency' => 'USD',
'scopeId' => '<string>',
'createdBy' => [
'id' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>'
],
'tags' => [
]
]),
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.example.com/events/{id}"
payload := strings.NewReader("{\n \"metadata\": {},\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"viewUsedForCreation\": {\n \"metricId\": \"<string>\",\n \"limit\": 123,\n \"groupBy\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"previousFrom\": \"<string>\",\n \"previousTo\": \"<string>\",\n \"whereClause\": {},\n \"currency\": \"USD\",\n \"threshold\": 123,\n \"explorerChartType\": \"BAR\",\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\"\n },\n \"widgetEvents\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"request\": {\n \"period\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"forecastDays\": 1\n },\n \"queries\": [\n {\n \"type\": \"condition\",\n \"expression\": \"<string>\",\n \"name\": \"<string>\",\n \"colorIndex\": 123,\n \"alias\": \"<string>\",\n \"visible\": true\n }\n ],\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\",\n \"limitOverride\": 500,\n \"displayOptions\": {\n \"hideEmptyRows\": true,\n \"topN\": 50,\n \"showTotal\": true,\n \"precision\": 3\n }\n },\n \"id\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"<string>\",\n \"metricId\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"conditions\": {},\n \"currency\": \"USD\",\n \"scopeId\": \"<string>\",\n \"createdBy\": {\n \"id\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"tags\": []\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.example.com/events/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {},\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"viewUsedForCreation\": {\n \"metricId\": \"<string>\",\n \"limit\": 123,\n \"groupBy\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"previousFrom\": \"<string>\",\n \"previousTo\": \"<string>\",\n \"whereClause\": {},\n \"currency\": \"USD\",\n \"threshold\": 123,\n \"explorerChartType\": \"BAR\",\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\"\n },\n \"widgetEvents\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"request\": {\n \"period\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"forecastDays\": 1\n },\n \"queries\": [\n {\n \"type\": \"condition\",\n \"expression\": \"<string>\",\n \"name\": \"<string>\",\n \"colorIndex\": 123,\n \"alias\": \"<string>\",\n \"visible\": true\n }\n ],\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\",\n \"limitOverride\": 500,\n \"displayOptions\": {\n \"hideEmptyRows\": true,\n \"topN\": 50,\n \"showTotal\": true,\n \"precision\": 3\n }\n },\n \"id\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"<string>\",\n \"metricId\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"conditions\": {},\n \"currency\": \"USD\",\n \"scopeId\": \"<string>\",\n \"createdBy\": {\n \"id\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"tags\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/events/{id}")
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 \"metadata\": {},\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"viewUsedForCreation\": {\n \"metricId\": \"<string>\",\n \"limit\": 123,\n \"groupBy\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"previousFrom\": \"<string>\",\n \"previousTo\": \"<string>\",\n \"whereClause\": {},\n \"currency\": \"USD\",\n \"threshold\": 123,\n \"explorerChartType\": \"BAR\",\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\"\n },\n \"widgetEvents\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"request\": {\n \"period\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"forecastDays\": 1\n },\n \"queries\": [\n {\n \"type\": \"condition\",\n \"expression\": \"<string>\",\n \"name\": \"<string>\",\n \"colorIndex\": 123,\n \"alias\": \"<string>\",\n \"visible\": true\n }\n ],\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\",\n \"limitOverride\": 500,\n \"displayOptions\": {\n \"hideEmptyRows\": true,\n \"topN\": 50,\n \"showTotal\": true,\n \"precision\": 3\n }\n },\n \"id\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"<string>\",\n \"metricId\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"conditions\": {},\n \"currency\": \"USD\",\n \"scopeId\": \"<string>\",\n \"createdBy\": {\n \"id\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body"<string>"{
"error": "<string>",
"reason": "<string>",
"details": "<unknown>",
"summary": "<string>"
}{
"error": "<string>"
}Events
Update an event
PUT
/
events
/
{id}
Update an event
curl --request PUT \
--url https://api.example.com/events/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {},
"name": "<string>",
"date": "2023-11-07T05:31:56Z",
"description": "<string>",
"viewUsedForCreation": {
"metricId": "<string>",
"limit": 123,
"groupBy": "<string>",
"from": "<string>",
"to": "<string>",
"previousFrom": "<string>",
"previousTo": "<string>",
"whereClause": {},
"currency": "USD",
"threshold": 123,
"explorerChartType": "BAR",
"bookmarkedEvents": [
"<string>"
],
"eventsFilter": {
"sources": [
"custom",
"api"
],
"githubSourceRepos": [],
"search": ""
},
"scopeId": "<string>"
},
"widgetEvents": [
{
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"request": {
"period": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"forecastDays": 1
},
"queries": [
{
"type": "condition",
"expression": "<string>",
"name": "<string>",
"colorIndex": 123,
"alias": "<string>",
"visible": true
}
],
"bookmarkedEvents": [
"<string>"
],
"eventsFilter": {
"sources": [
"custom",
"api"
],
"githubSourceRepos": [],
"search": ""
},
"scopeId": "<string>",
"limitOverride": 500,
"displayOptions": {
"hideEmptyRows": true,
"topN": 50,
"showTotal": true,
"precision": 3
}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"title": "",
"description": ""
}
],
"id": "<string>",
"metricId": "<string>",
"groupBy": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"conditions": {},
"currency": "USD",
"scopeId": "<string>",
"createdBy": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"tags": []
}
'import requests
url = "https://api.example.com/events/{id}"
payload = {
"metadata": {},
"name": "<string>",
"date": "2023-11-07T05:31:56Z",
"description": "<string>",
"viewUsedForCreation": {
"metricId": "<string>",
"limit": 123,
"groupBy": "<string>",
"from": "<string>",
"to": "<string>",
"previousFrom": "<string>",
"previousTo": "<string>",
"whereClause": {},
"currency": "USD",
"threshold": 123,
"explorerChartType": "BAR",
"bookmarkedEvents": ["<string>"],
"eventsFilter": {
"sources": ["custom", "api"],
"githubSourceRepos": [],
"search": ""
},
"scopeId": "<string>"
},
"widgetEvents": [
{
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"request": {
"period": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"forecastDays": 1
},
"queries": [
{
"type": "condition",
"expression": "<string>",
"name": "<string>",
"colorIndex": 123,
"alias": "<string>",
"visible": True
}
],
"bookmarkedEvents": ["<string>"],
"eventsFilter": {
"sources": ["custom", "api"],
"githubSourceRepos": [],
"search": ""
},
"scopeId": "<string>",
"limitOverride": 500,
"displayOptions": {
"hideEmptyRows": True,
"topN": 50,
"showTotal": True,
"precision": 3
}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"title": "",
"description": ""
}
],
"id": "<string>",
"metricId": "<string>",
"groupBy": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"conditions": {},
"currency": "USD",
"scopeId": "<string>",
"createdBy": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"tags": []
}
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({
metadata: {},
name: '<string>',
date: '2023-11-07T05:31:56Z',
description: '<string>',
viewUsedForCreation: {
metricId: '<string>',
limit: 123,
groupBy: '<string>',
from: '<string>',
to: '<string>',
previousFrom: '<string>',
previousTo: '<string>',
whereClause: {},
currency: 'USD',
threshold: 123,
explorerChartType: 'BAR',
bookmarkedEvents: ['<string>'],
eventsFilter: {sources: ['custom', 'api'], githubSourceRepos: [], search: ''},
scopeId: '<string>'
},
widgetEvents: [
{
x: 123,
y: 123,
w: 123,
h: 123,
request: {
period: {
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
forecastDays: 1
},
queries: [
{
type: 'condition',
expression: '<string>',
name: '<string>',
colorIndex: 123,
alias: '<string>',
visible: true
}
],
bookmarkedEvents: ['<string>'],
eventsFilter: {sources: ['custom', 'api'], githubSourceRepos: [], search: ''},
scopeId: '<string>',
limitOverride: 500,
displayOptions: {hideEmptyRows: true, topN: 50, showTotal: true, precision: 3}
},
id: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedAt: '2023-11-07T05:31:56Z',
title: '',
description: ''
}
],
id: '<string>',
metricId: '<string>',
groupBy: '<string>',
startDate: '<string>',
endDate: '<string>',
conditions: {},
currency: 'USD',
scopeId: '<string>',
createdBy: {id: '<string>', firstName: '<string>', lastName: '<string>'},
tags: []
})
};
fetch('https://api.example.com/events/{id}', 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.example.com/events/{id}",
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([
'metadata' => [
],
'name' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'viewUsedForCreation' => [
'metricId' => '<string>',
'limit' => 123,
'groupBy' => '<string>',
'from' => '<string>',
'to' => '<string>',
'previousFrom' => '<string>',
'previousTo' => '<string>',
'whereClause' => [
],
'currency' => 'USD',
'threshold' => 123,
'explorerChartType' => 'BAR',
'bookmarkedEvents' => [
'<string>'
],
'eventsFilter' => [
'sources' => [
'custom',
'api'
],
'githubSourceRepos' => [
],
'search' => ''
],
'scopeId' => '<string>'
],
'widgetEvents' => [
[
'x' => 123,
'y' => 123,
'w' => 123,
'h' => 123,
'request' => [
'period' => [
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'forecastDays' => 1
],
'queries' => [
[
'type' => 'condition',
'expression' => '<string>',
'name' => '<string>',
'colorIndex' => 123,
'alias' => '<string>',
'visible' => true
]
],
'bookmarkedEvents' => [
'<string>'
],
'eventsFilter' => [
'sources' => [
'custom',
'api'
],
'githubSourceRepos' => [
],
'search' => ''
],
'scopeId' => '<string>',
'limitOverride' => 500,
'displayOptions' => [
'hideEmptyRows' => true,
'topN' => 50,
'showTotal' => true,
'precision' => 3
]
],
'id' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z',
'title' => '',
'description' => ''
]
],
'id' => '<string>',
'metricId' => '<string>',
'groupBy' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'conditions' => [
],
'currency' => 'USD',
'scopeId' => '<string>',
'createdBy' => [
'id' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>'
],
'tags' => [
]
]),
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.example.com/events/{id}"
payload := strings.NewReader("{\n \"metadata\": {},\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"viewUsedForCreation\": {\n \"metricId\": \"<string>\",\n \"limit\": 123,\n \"groupBy\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"previousFrom\": \"<string>\",\n \"previousTo\": \"<string>\",\n \"whereClause\": {},\n \"currency\": \"USD\",\n \"threshold\": 123,\n \"explorerChartType\": \"BAR\",\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\"\n },\n \"widgetEvents\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"request\": {\n \"period\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"forecastDays\": 1\n },\n \"queries\": [\n {\n \"type\": \"condition\",\n \"expression\": \"<string>\",\n \"name\": \"<string>\",\n \"colorIndex\": 123,\n \"alias\": \"<string>\",\n \"visible\": true\n }\n ],\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\",\n \"limitOverride\": 500,\n \"displayOptions\": {\n \"hideEmptyRows\": true,\n \"topN\": 50,\n \"showTotal\": true,\n \"precision\": 3\n }\n },\n \"id\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"<string>\",\n \"metricId\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"conditions\": {},\n \"currency\": \"USD\",\n \"scopeId\": \"<string>\",\n \"createdBy\": {\n \"id\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"tags\": []\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.example.com/events/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {},\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"viewUsedForCreation\": {\n \"metricId\": \"<string>\",\n \"limit\": 123,\n \"groupBy\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"previousFrom\": \"<string>\",\n \"previousTo\": \"<string>\",\n \"whereClause\": {},\n \"currency\": \"USD\",\n \"threshold\": 123,\n \"explorerChartType\": \"BAR\",\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\"\n },\n \"widgetEvents\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"request\": {\n \"period\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"forecastDays\": 1\n },\n \"queries\": [\n {\n \"type\": \"condition\",\n \"expression\": \"<string>\",\n \"name\": \"<string>\",\n \"colorIndex\": 123,\n \"alias\": \"<string>\",\n \"visible\": true\n }\n ],\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\",\n \"limitOverride\": 500,\n \"displayOptions\": {\n \"hideEmptyRows\": true,\n \"topN\": 50,\n \"showTotal\": true,\n \"precision\": 3\n }\n },\n \"id\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"<string>\",\n \"metricId\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"conditions\": {},\n \"currency\": \"USD\",\n \"scopeId\": \"<string>\",\n \"createdBy\": {\n \"id\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"tags\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/events/{id}")
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 \"metadata\": {},\n \"name\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"viewUsedForCreation\": {\n \"metricId\": \"<string>\",\n \"limit\": 123,\n \"groupBy\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"previousFrom\": \"<string>\",\n \"previousTo\": \"<string>\",\n \"whereClause\": {},\n \"currency\": \"USD\",\n \"threshold\": 123,\n \"explorerChartType\": \"BAR\",\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\"\n },\n \"widgetEvents\": [\n {\n \"x\": 123,\n \"y\": 123,\n \"w\": 123,\n \"h\": 123,\n \"request\": {\n \"period\": {\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"forecastDays\": 1\n },\n \"queries\": [\n {\n \"type\": \"condition\",\n \"expression\": \"<string>\",\n \"name\": \"<string>\",\n \"colorIndex\": 123,\n \"alias\": \"<string>\",\n \"visible\": true\n }\n ],\n \"bookmarkedEvents\": [\n \"<string>\"\n ],\n \"eventsFilter\": {\n \"sources\": [\n \"custom\",\n \"api\"\n ],\n \"githubSourceRepos\": [],\n \"search\": \"\"\n },\n \"scopeId\": \"<string>\",\n \"limitOverride\": 500,\n \"displayOptions\": {\n \"hideEmptyRows\": true,\n \"topN\": 50,\n \"showTotal\": true,\n \"precision\": 3\n }\n },\n \"id\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"<string>\",\n \"metricId\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"conditions\": {},\n \"currency\": \"USD\",\n \"scopeId\": \"<string>\",\n \"createdBy\": {\n \"id\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body"<string>"{
"error": "<string>",
"reason": "<string>",
"details": "<unknown>",
"summary": "<string>"
}{
"error": "<string>"
}Authorizations
Send Authorization: Bearer <credential> using either a Clerk session JWT or a Clerk API key (ak_*). API keys may identify a user (user_*) or organization (org_*) principal and are generated in the Clerk Dashboard under API keys.
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Minimum string length:
5Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
TRAILING_90_DAYS, TRAILING_30_DAYS, TRAILING_45_DAYS, TRAILING_7_DAYS, TRAILING_3_DAYS, TRAILING_1_DAYS, TRAILING_14_WEEKS, MTD, QTD, YTD, CURRENT_MONTH, CURRENT_QUARTER, CURRENT_YEAR, LAST_WEEK, LAST_MONTH, LAST_6_MONTHS, LAST_12_MONTHS, LAST_4_YEARS, LAST_3_MONTHS, LAST_INVOICE_MONTH Show child attributes
Show child attributes
Available options:
EUR, USD, GBP, CNY, KRW Show child attributes
Show child attributes
Available options:
custom, provider, github, api Response
Event updated successfully
The response is of type string.
Was this page helpful?