Share a Tip

How to create Analytics Metrics using API

Morelz
Motivator

Creating large amounts of Analytics Metrics takes some time, and there is no official API to support this function currently.

If you wish to automate this in the interim , to reduce the time taken to create them you can do the following.

You would run the Authentication URL to get the JSESSIONID & X-CSRF-TOKEN values by running the following command

curl -i --user @sername@account:password https://<controller url>/controller/auth?action=login

Then using the following URL, you can create the Metric 

https://<controller url>/controller/restui/analyticsMetric/create

Set the Header values with the responses from the Auth Query(I used Postman for this example)

image.png

Provide the Metric query you wish to create, example below

{"adqlQueryString":"SELECT avg(responseTime) FROM transactions WHERE application = \"TEST\"","eventType":"BIZ_TXN","enabled":true,"queryType":"ADQL_QUERY","queryName":"TEST"}
 
You should then get a status 204 if it was successful.
 
Depending on how complex your queries are it might fail as certain strings need to be escaped. What I would suggest initially is to manually create the queries, and use developer options in your browser to view the API call being made to ensure you provide the queries in the correct format and then automate it.
Tags (2)
Get Updates on the Splunk Community!

Aligning Observability Costs with Business Value: Practical Strategies

 Join us for an engaging Tech Talk on Aligning Observability Costs with Business Value: Practical ...

Mastering Data Pipelines: Unlocking Value with Splunk

 In today's AI-driven world, organizations must balance the challenges of managing the explosion of data with ...

Splunk Up Your Game: Why It's Time to Embrace Python 3.9+ and OpenSSL 3.0

Did you know that for Splunk Enterprise 9.4, Python 3.9 is the default interpreter? This shift is not just a ...