Skip to main content
POST
/
v3
/
groups
/
definitions
/
{group}
/
snapshots
Start a manual snapshot run for a dynamic group
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/snapshots
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/snapshots"

response = requests.post(url)

print(response.text)
const options = {method: 'POST'};

fetch('https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/snapshots', 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.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/snapshots",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/snapshots"

req, _ := http.NewRequest("POST", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/snapshots")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/groups/definitions/{group}/snapshots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": 123,
    "group_definition_id": 123,
    "status": "<string>",
    "source": "<string>",
    "snapshot_at": "<string>",
    "started_at": "<string>",
    "completed_at": "<string>",
    "failed_at": "<string>",
    "error": "<string>",
    "total_candidates": 123,
    "total_excluded": 123,
    "total_profiles": 123,
    "inclusion_breakdown": [
      "<unknown>"
    ],
    "exclusion_breakdown": [
      "<unknown>"
    ],
    "duration_ms": 123,
    "meta": [
      "<unknown>"
    ],
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>"
}

Path Parameters

group
integer
required

The group ID

Response

GroupSnapshot

data
GroupSnapshot · object
required