Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>Sorry for the scarcity of available examples. More and better examples will be coming as the LBAPI beta matures. I'd definitely recommend that you become familiar with the <a href="https://rally1.rallydev.com/analytics/doc" rel="nofollow">Lookback API (LBAPI) Documentation</a>, as there are good examples there for formulating queries.</p> <p>For a burnup, let's say you want to get the state Snapshots for an Iteration going from 15-Jan-2013 through 30-Jan-2013, and that the Iteration applies to a Project hierarchy that is four-deep. The following LBAPI query would obtain the PlanEstimate, ToDo, and Schedule State for Stories scheduled into that Iteration:</p> <pre><code>{ find: { _TypeHierarchy:"HierarchicalRequirement", Children:null, _ValidFrom:{ $gte:"2013-01-15TZ", $lt:"2013-01-30TZ" }, Iteration:{ $in:[ 12345678910, 12345678911, 12345678912, 12345678913 ] } }, fields:[ "PlanEstimate", "ToDo", "ScheduleState" ] } </code></pre> <p>Where:</p> <pre><code> $in:[ 12345678910, 12345678911, 12345678912, 12345678913 ] </code></pre> <p>Are the ObjectID's of the Iteration called "Iteration 1". It's probably easiest to get these Object ID's from a standard WSAPI query on Iterations: <code>(Name = "Iteration 1")</code>. For Iterations copied into a four-deep project hierarchy, we would see the four Iteration OID's similar to the above.</p> <p>For charting, the toughest part right now is an easy way to deal with the Time-Series data. The most robust way to query and process LBAPI data currently is by working directly against the REST endpoint and processing the returned JSON results in your own code.</p> <p>With Javascript apps, for processing the data and turning it into a Chart, the preferred toolkit is <a href="http://developer.help.rallydev.com/apps/2.0p5/doc/" rel="nofollow">AppSDK2</a>, specifically the <a href="http://developer.help.rallydev.com/apps/2.0p5/doc/#!/api/Rally.data.lookback.SnapshotStore" rel="nofollow">SnapshotStore</a>.</p> <p>For Javascript apps, the <a href="https://npmjs.org/package/Lumenize" rel="nofollow">Lumenize javascript library</a> is separate from LBAPI, but was developed by Rally's director of analytics and is bundled in the SDK. You can find some examples of using LBAPI and Lumenize to produce charting as part of some Rally-internal and Rally-customer Hackathon projects here:</p> <p><a href="https://github.com/RallyHackathon" rel="nofollow">https://github.com/RallyHackathon</a></p> <p>Please be cautious with these examples for a couple of reasons:</p> <ul> <li>Several aspects of the Lumenize namespace will be changing/renamed for clarity</li> <li>There's a bug in the current version of Lumenize where its timeSeriesCalculator does not correctly account for stories deleted or reparented.</li> </ul> <p>Hopefully there will be an updated version of AppSDK2 bundled and released soon to consolidate the Lumenize namespace and resolve the bug, so that there's better glue between AppSDK2 and LBAPI for Javascript App development.</p>
    singulars
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload