Get pinned results
1 min
POST
https://cg.optimizely.com/api/pinned/results
Body Parameters
- bodyPinnedResultMatchParamsrequired
- phrasestringrequired
- collectionIdsstring[]
- collectionKeysstring[]
- languagesstring[]
- onlyActiveboolean
- limitnumber<double>Formatdouble
Responses
200
- PinnedItemResult[]
- phrasesstringrequiredDescription
- targetKeystringrequiredDescription
- languagestringDescription
- prioritynumber<double>DescriptionDefault1000Formatdouble
- isActivebooleanDefaulttrue
- idstringrequired
- collectionIdstringrequired
- createdAtstringrequired
- updatedAtstringrequired
curl
curl --request POST \
--url https://cg.optimizely.com/api/pinned/results \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"phrase": ""
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"phrase": ""
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://cg.optimizely.com/api/pinned/results", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://cg.optimizely.com/api/pinned/results")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"phrase": ""
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://cg.optimizely.com/api/pinned/results"
payload = json.dumps({
"phrase": ""
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Ok
[
{
"phrases": "",
"targetKey": "",
"language": "",
"priority": "",
"isActive": false,
"id": "",
"collectionId": "",
"createdAt": "",
"updatedAt": ""
}
]