API for YARN Data Retrieval

With Acceldata Pulse APIs, you can programmatically access YARN and application-level data and use it in your own systems, dashboards, or workflows.

In this page, you’ll learn how to:

• Authenticate and access Pulse APIs
• Retrieve Application Explorer data
• Explore YARN data (queues, capacity, summary)

Authentication

Before you can call any APIs, you need a JWT token.

For details about generating your token, see How to Use Pulse Public APIs.

Call the API Endpoint

All API requests go through the GraphQL endpoint:

xxxxxxxxxx

POST https://<your-pulse-url>/graphql

Example:

xxxxxxxxxx

https://trial.acceldata.dev/graphql

Retrieve Application Explorer Data

What You Can Get

You can fetch the same data you see in the Application Explorer UI, including:

• Application ID
• Type
• State
• Name
• User
• Queue
• Progress
• Start Time
• Elapsed Time
• Finished Time
• Priority
• Cluster Usage (%)
• Queue Usage (%)
• Application Tags
• Allocated Memory (MB)
• Allocated vCores
• Memory Seconds
• vCore Seconds

Use This GraphQL Operation

YarnAppDataForExplorer

Example API Request

curl 'https://<your-pulse-url>/graphql' \

 -H 'content-type: application/json' \

 -b 'jwt=<your-jwt-token>' \

 --data-raw '{

   "operationName": "YarnAppDataForExplorer",

   "variables": {

     "tableMetadata": {

       "pageNo": 1,

       "pageSize": 20,

       "start": "<start_timestamp>",

       "end": "<end_timestamp>"

     }

   },

   "query": "query YarnAppDataForExplorer($tableMetadata: TableMetadata!) { yarnAppDataForExplorer(tableMetadata: $tableMetadata) { id name queue user state applicationType progress startedTime finishedTime elapsedTime priority clusterUsagePercentage queueUsagePercentage applicationTags allocatedMB allocatedVCores memorySeconds vcoreSeconds } }"

 }'

Example Response

xxxxxxxxxx

{

 "data": {

   "yarnAppDataForExplorer": [

     {

       "id": "application_123456",

       "name": "Spark Job Example",

       "queue": "default",

       "user": "hadoop_user",

       "state": "FINISHED",

       "applicationType": "SPARK",

       "progress": 100,

       "startedTime": 1774809183525,

       "finishedTime": 1774812783525,

       "elapsedTime": 3600000,

       "priority": 1,

       "clusterUsagePercentage": 12.5,

       "queueUsagePercentage": 45.2,

       "applicationTags": ["etl", "daily"],

       "allocatedMB": 4096,

       "allocatedVCores": 4,

       "memorySeconds": 123456789,

       "vcoreSeconds": 98765432

     }

   ]

 }

}

Explore YARN Data

What You Can Access

You can also retrieve YARN-related insights such as:

Queue List

• All queues and hierarchy
• Capacity allocation

Example Request:

Example Response:

Queue Details

• Capacity and usage

Example Request:

Example Response:

• Running and pending applications
• Resource allocation

YARN Summary

• Total cluster resources
• Used vs available memory and vCores
• Node and application counts

How You Discover These APIs

YARN APIs are powered by GraphQL queries used internally by the UI. To access them:

1. Open Pulse in your browser

2. Go to the YARN tab

3. Open Developer Tools → Network tab

4. Filter for GraphQL requests

5. Click on relevant requests (queues, summary, etc.)

6. Copy:

   • Query
   • Variables
   • Response

7. Reuse the same query in your API calls

Example:

What You Can Build

With these APIs, you can:

• Build your own custom dashboards
• Export data to BI tools or data lakes
• Automate reports and pipelines
• Monitor cluster utilization programmatically
• Optimize resource usage and costs