You are here:

Create a Discover report

{ createDiscover }

Creates a new Discover report item for a given Semantic Data model with model selections and visualization settings.

Method

/API3/analytics/createDiscover

API Section: /API3/analytics

API Version: 3.0

From Release: 2023.10

Usage: REST API and Client SDK libraries. REST APIs via POST actions only.

Usage by:

Enterprise Admin
Domain Admin
Pro
Analyst
Viewer

Input Parameters

Name

discoverData

Object Type

DiscoverData

Description

Metadata details of the Discover item

Output Response

Successful Result Code

200

Response Type

string

Description of Response Type

Returns the created discover ID

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript

Curl

Java

Python

PHP

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/createDiscover" \
 -d '{
  "itemName" : "itemName",
  "visuals" : {
    "grid" : {
      "filter" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "indicator" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "values" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "rows" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "cols" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      }
    },
    "segment" : {
      "filter" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "trellisHorizontal" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "motion" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "trellisVertical" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "values" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "details" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "labels" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      }
    },
    "scatter" : {
      "trellisHorizontal" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "motion" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "shape" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "trellisVertical" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "yValues" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "xValues" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "labels" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "filter" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "details" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      }
    },
    "tabular" : {
      "filter" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "cols" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      }
    },
    "map" : {
      "filter" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "motion" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "location" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "details" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      }
    },
    "cartesian" : {
      "filter" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "trellisHorizontal" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "color" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName",
            "targetMeasure" : "targetMeasure"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "size" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "motion" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "shape" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "trellisVertical" : {
        "dropZoneChips" : [ {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "values" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "values" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName",
          "chartType" : { },
          "targetMeasure" : "targetMeasure"
        }, {
          "uniqueName" : "uniqueName",
          "chartType" : { },
          "targetMeasure" : "targetMeasure"
        } ]
      },
      "tooltip" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      },
      "categories" : {
        "dropZoneChips" : [ {
          "uniqueName" : "uniqueName"
        }, {
          "uniqueName" : "uniqueName"
        } ]
      },
      "labels" : {
        "dropZoneChips" : [ {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        }, {
          "measure" : {
            "uniqueName" : "uniqueName"
          },
          "hierarchy" : {
            "uniqueName" : "uniqueName"
          }
        } ]
      }
    }
  },
  "queryOptions" : {
    "showEmpties" : true,
    "totalsSettings" : {
      "colTotalSettings" : { },
      "rowTotalSettings" : { }
    },
    "executionSettings" : {
      "Optimized" : true,
      "SubQueryMode" : true
    }
  },
  "themeId" : "themeId",
  "description" : "description",
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "folderId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "elementSelections" : [ {
    "all" : true,
    "selectionsList" : [ {
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    }, {
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    } ],
    "uniqueName" : "uniqueName"
  }, {
    "all" : true,
    "selectionsList" : [ {
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    }, {
      "UniqueNames" : [ "UniqueNames", "UniqueNames" ]
    } ],
    "uniqueName" : "uniqueName"
  } ],
  "tags" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}'

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 discoverData parameter object for the call
        DiscoverData discoverData = ; // Create the input object for the operation, type: DiscoverData 

        try {
            UUID result = apiInstance.createDiscover(discoverData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsServiceApi#createDiscover");
            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 discoverData = ; // {DiscoverData} 

api.createDiscover(discoverData).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 createDiscoverExample
{
    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 discoverData parameter object for the call
        var discoverData = new DiscoverData(); // DiscoverData | 

        try {
            // Creates a new Discover report item for a given Semantic Data model with model selections and visualization settings.
            Guid result = apiInstance.createDiscover(discoverData);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AnalyticsServiceApi.createDiscover: " + 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 discoverData parameter object for the call
    discoverData =  # DiscoverData | 

    try:
        # Creates a new Discover report item for a given Semantic Data model with model selections and visualization settings.
        api_response = api_instance.create_discover(discoverData)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnalyticsServiceApi->createDiscover: %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();
$discoverData = ; // DiscoverData | 

try {
    $result = $api_instance->createDiscover($discoverData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsServiceApi->createDiscover: ', $e->getMessage(), PHP_EOL;
}
?>

Feedback

Couldn't find what I was looking for

Help was confusing, unclear or incomplete

Instructions didn't work