Create report of SMS devices - entries in response
POST {{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries
Use POST {{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries to create a report of all SMS devices.
Points to note:
-
The
expand=entriesparameter in the URL specifies that the results should be included in the response. If not included in the URL, the results would only be returned in the response to a subsequent GET…/entriesrequest. -
When you use the
expandquery parameter, you must setsyncto true.
Query parameters
| Query parameter | Attributes (or allowed limits) |
|---|---|
|
N/A |
|
(1-1000) |
|
|
|
N/A |
Request Model
Refer to Reporting for more information, including the complete data model.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Optional |
|
Array |
Optional |
|
String |
Optional |
|
String |
Optional |
Body
raw ( application/json )
{
"dataExplorationTemplate": {
"id": "{{dataExplorationTemplateID}}"
},
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
},
{
"name": "deviceStatus"
},
{
"name": "deviceId"
}
],
"filter": "(deviceType eq \"SMS\")",
"sync": "true",
"deliverAs":"ENTRIES"
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"dataExplorationTemplate": {
"id": "{{dataExplorationTemplateID}}"
},
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
},
{
"name": "deviceStatus"
},
{
"name": "deviceId"
}
],
"filter": "(deviceType eq \"SMS\")",
"sync": "true",
"deliverAs":"ENTRIES"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""dataExplorationTemplate"": {" + "\n" +
@" ""id"": ""{{dataExplorationTemplateID}}""" + "\n" +
@" }," + "\n" +
@" ""fields"": [" + "\n" +
@" { " + "\n" +
@" ""name"": ""userId""" + "\n" +
@" }," + "\n" +
@" { " + "\n" +
@" ""name"": ""username""" + "\n" +
@" }," + "\n" +
@" { " + "\n" +
@" ""name"": ""phone""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""name"": ""deviceStatus""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""name"": ""deviceId""" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""filter"": ""(deviceType eq \""SMS\"")"", " + "\n" +
@" ""sync"": ""true""," + "\n" +
@" ""deliverAs"":""ENTRIES""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries"
method := "POST"
payload := strings.NewReader(`{
"dataExplorationTemplate": {
"id": "{{dataExplorationTemplateID}}"
},
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
},
{
"name": "deviceStatus"
},
{
"name": "deviceId"
}
],
"filter": "(deviceType eq \"SMS\")",
"sync": "true",
"deliverAs":"ENTRIES"
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
POST /environments/{{envID}}/dataExplorations?expand=entries HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"dataExplorationTemplate": {
"id": "{{dataExplorationTemplateID}}"
},
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
},
{
"name": "deviceStatus"
},
{
"name": "deviceId"
}
],
"filter": "(deviceType eq \"SMS\")",
"sync": "true",
"deliverAs":"ENTRIES"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"dataExplorationTemplate\": {\n \"id\": \"{{dataExplorationTemplateID}}\"\n },\n \"fields\": [\n { \n \"name\": \"userId\"\n },\n { \n \"name\": \"username\"\n },\n { \n \"name\": \"phone\"\n },\n {\n \"name\": \"deviceStatus\"\n },\n {\n \"name\": \"deviceId\"\n }\n ],\n \"filter\": \"(deviceType eq \\\"SMS\\\")\", \n \"sync\": \"true\",\n \"deliverAs\":\"ENTRIES\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"dataExplorationTemplate": {
"id": "{{dataExplorationTemplateID}}"
},
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
},
{
"name": "deviceStatus"
},
{
"name": "deviceId"
}
],
"filter": "(deviceType eq \"SMS\")",
"sync": "true",
"deliverAs": "ENTRIES"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"dataExplorationTemplate": {
"id": "{{dataExplorationTemplateID}}"
},
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
},
{
"name": "deviceStatus"
},
{
"name": "deviceId"
}
],
"filter": "(deviceType eq \"SMS\")",
"sync": "true",
"deliverAs": "ENTRIES"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries"
payload = json.dumps({
"dataExplorationTemplate": {
"id": "{{dataExplorationTemplateID}}"
},
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
},
{
"name": "deviceStatus"
},
{
"name": "deviceId"
}
],
"filter": "(deviceType eq \"SMS\")",
"sync": "true",
"deliverAs": "ENTRIES"
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "dataExplorationTemplate": {\n "id": "{{dataExplorationTemplateID}}"\n },\n "fields": [\n { \n "name": "userId"\n },\n { \n "name": "username"\n },\n { \n "name": "phone"\n },\n {\n "name": "deviceStatus"\n },\n {\n "name": "deviceId"\n }\n ],\n "filter": "(deviceType eq \\"SMS\\")", \n "sync": "true",\n "deliverAs":"ENTRIES"\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"dataExplorationTemplate": {
"id": "{{dataExplorationTemplateID}}"
},
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
},
{
"name": "deviceStatus"
},
{
"name": "deviceId"
}
],
"filter": "(deviceType eq \"SMS\")",
"sync": "true",
"deliverAs": "ENTRIES"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"dataExplorationTemplate\": {\n \"id\": \"{{dataExplorationTemplateID}}\"\n },\n \"fields\": [\n { \n \"name\": \"userId\"\n },\n { \n \"name\": \"username\"\n },\n { \n \"name\": \"phone\"\n },\n {\n \"name\": \"deviceStatus\"\n },\n {\n \"name\": \"deviceId\"\n }\n ],\n \"filter\": \"(deviceType eq \\\"SMS\\\")\", \n \"sync\": \"true\",\n \"deliverAs\":\"ENTRIES\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/dataExplorations?expand=entries")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "POST"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
202 Accepted
{
"_links": {
"self": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7"
},
"environment": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"entries": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7/entries"
},
"dataExplorationTemplate": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorationTemplates/db632bfd-7054-4bde-b108-a384aac2d513"
}
},
"id": "0f1c6a59-6099-4539-a2b1-26c3220149a7",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-12-27T14:22:50.000Z",
"updatedAt": "2022-12-27T14:22:50.000Z",
"expiresAt": "2022-12-27T14:52:50.000Z",
"fields": [
{
"name": "userId"
},
{
"name": "username"
},
{
"name": "phone"
}
],
"filter": "(deviceType eq \"SMS\")",
"orderBy": [],
"status": "SUCCESS",
"deliverAs": "ENTRIES",
"sync": true,
"_embedded": {
"entries": [
{
"_links": {
"self": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7/entries/1"
},
"environment": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"dataExploration": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7"
},
"next": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7/entries/2"
}
},
"id": 1,
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-12-27T14:22:50.528Z",
"updatedAt": "2022-12-27T14:22:50.528Z",
"expiresAt": "2022-12-27T14:22:50.528Z",
"dataExploration": {
"id": "0f1c6a59-6099-4539-a2b1-26c3220149a7"
},
"values": [
"991776fd-145b-499e-8237-2c62aef35b2c",
"glucks",
"972547339044"
]
},
{
"_links": {
"self": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7/entries/2"
},
"environment": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"dataExploration": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7"
},
"next": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7/entries/3"
}
},
"id": 2,
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-12-27T14:22:50.531Z",
"updatedAt": "2022-12-27T14:22:50.531Z",
"expiresAt": "2022-12-27T14:22:50.531Z",
"dataExploration": {
"id": "0f1c6a59-6099-4539-a2b1-26c3220149a7"
},
"values": [
"b30ac647-e33e-464f-a6ea-0275082d4c26",
"antonik_adham",
"+14135550150"
]
},
{
"_links": {
"self": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7/entries/3"
},
"environment": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"dataExploration": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0f1c6a59-6099-4539-a2b1-26c3220149a7"
}
},
"id": 3,
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-12-27T14:22:50.531Z",
"updatedAt": "2022-12-27T14:22:50.531Z",
"expiresAt": "2022-12-27T14:22:50.531Z",
"dataExploration": {
"id": "0f1c6a59-6099-4539-a2b1-26c3220149a7"
},
"values": [
"b30ac647-e33e-464f-a6ea-0275082d4c26",
"antonik_adham",
"+14135550150"
]
}
]
},
"dataExplorationTemplate": {
"id": "db632bfd-7054-4bde-b108-a384aac2d513",
"name": "Devices report"
}
}