Extract a Slicer / Parameter's members
{ getParameterElements }
Enumerates and returns the members/elements contained in a Formulation parameter - useful for building slicer lists outside of the application.
Method
- Enterprise Admin
- Domain Admin
- Pro
- Analyst
- Viewer
- Basic
Input Parameters
Name
parameterId
Type
string
Description
The parameter's system ID
Output Response
Successful Result Code
200
Response Type
Description of Response Type
The members/elements contained in a Formulation parameter
Notes
To use this function, create custom 'Lists' and 'Parameters' in the application. The resultset can then be used to drive external applications like filtering embedded content. The parameter's ID comes from the content manager inside the main client application.
Examples
This example demonstrates how to run queries and slicers (parameters) programmatically to extract results.
The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.
// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";
// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
"userName":"adminUser",
"password":"abc123!"
},token,false);
//step 2: find a parameter definition called "param x". Parameters are saved items to drive slicers
let calculation = callApi("content/findContentItem",{
"searchString": "param x",
"filterTypes": [2],
"searchMatchType": 2,
"searchRootFolderType":0
},token // admin token generated above
);
let paramId = calculation[0].id;
//step 3: get the parameter's elements
let parameterElements = callApi("analytics/getParameterElements",paramId,token);
let members = parameterElements.members // list for members
console.log(members);
//step 4: find a data discovery called "report x"
let dataDiscovery = callApi("content/findContentItem",{
"searchString": "report x",
"filterTypes": [3],
"searchMatchType": 2,
"searchRootFolderType":0
},token // admin token generated above
);
let reportId = dataDiscovery[0].id;
//step 5: extract the report results as JSON that have been filtered by the first member of the parameter found in step 3
let queryResult = callApi("analytics/extractQueryResult",{
"itemId":reportId,
"exportType":0, //JSON
"exportOptions": {},
"externalParameters": {
"reportFilters" : [
{
"value": members[0].uniqueName
}
]
}
},token);
console.log(JSON.parse(queryResult));
// ##### optional generic logging method for debugging ##############
function log(msg){
document.write(msg);
console.log(msg);
}
// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
var xhttp = new XMLHttpRequest();
xhttp.open("POST", pyramidURL+path, false);
xhttp.setRequestHeader("paToken",token)
xhttp.send(JSON.stringify(data));
if(parseResult){
return JSON.parse(xhttp.responseText);
}else{
return xhttp.responseText;
}
}
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/csv,text/csv;charset=utf-8,application/xml,application/xml;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/analytics/getParameterElements" \
-d ''
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AnalyticsServiceApi;
import java.util.*;
import java.time.*;
public class AnalyticsServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
AnalyticsServiceApi apiInstance = new AnalyticsServiceApi();
// Initialize the parameterId parameter object for the call
String parameterId = parameterId_example; // Create the input object for the operation, type: String
try {
EnumerationOutput result = apiInstance.getParameterElements(parameterId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalyticsServiceApi#getParameterElements");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AnalyticsServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const parameterId = parameterId_example; // {String}
api.getParameterElements(parameterId).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class getParameterElementsExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new AnalyticsServiceApi();
// Initialize the parameterId parameter object for the call
var parameterId = parameterId_example; // Create the input object for the operation, type: String |
try {
// Enumerates and returns the members/elements contained in a Formulation parameter - useful for building slicer lists outside of the application.
EnumerationOutput result = apiInstance.getParameterElements(parameterId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling AnalyticsServiceApi.getParameterElements: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import AnalyticsServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = AnalyticsServiceApi(api_client)
# Initialize the parameterId parameter object for the call
parameterId = parameterId_example # String |
try:
# Enumerates and returns the members/elements contained in a Formulation parameter - useful for building slicer lists outside of the application.
api_response = api_instance.get_parameter_elements(parameterId)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsServiceApi->getParameterElements: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnalyticsServiceApi();
$parameterId = parameterId_example; // String |
try {
$result = $api_instance->getParameterElements($parameterId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsServiceApi->getParameterElements: ', $e->getMessage(), PHP_EOL;
}
?>