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)
Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

Request for Professional Development: Attending .conf26

Winning Over the Boss: Your Pass to .conf26 conf26 is going to be here before you know it. If don't already ...

[Puzzles] Solve, Learn, Repeat: Classic British Rock Bands

This puzzle series (first published here) is based on extracting information from statements about well-known ...

New to the Community? Join Us for an Exclusive Post .conf26 Welcome Session (Plus a ...

Keep the .conf26 Energy Going: Welcome to the Splunk Community! Whether we scanned your badge at the Community ...