Skip to main content

 

Planview Customer Success Center

Advanced Reporting API: Card Planning Increments Endpoint

GET /io/reporting/export/cards/planningincrements

Returns all the cards with planning increments assigned.

Resource URL

GET https://{accountname}.leankit.com/io/reporting/export/cards/planningincrements?token=xyzyz

See Export Parameters for more information on specifying response formats and other options.

Example request

GET https://myaccount.leankit.com/io/reporting/export/cards/planningincrements?token=xyxyz

Response   

Column Description
Card Id  
Card Title  
Board Id  
Board Title  
Planning Series Id  
Planning Series Label  
Planning Increment Id  
Planning Increment Label  
Parent Planning Increment Id  
Parent Planning Increment Label

Example response

"Card ID","Card Title","Board ID","Board Title","Planning Series Id","Planning Series Label","Planning Increment Id","Planning Increment Label","Parent Planning Increment Id","Parent Planning Increment Label"
"20114192826","Portal Upgrade","20114176223","Board B","20114169089","Quarterly Planning Series","20114179391","January","20114169189","Qtr 1"
"20114192318","Fix editor defect","20114176223","Board B","20114169089","Quarterly Planning Series","20114179391","January","20114169189","Qtr 1"
"20114188177","Document the process","20114176223","Board B","20114168785","Alternative Series","20114176565","Week 1","20114176563","Six Weeks #3"
"20114188076","Implement the plan","20114176223","Board B","20114168785","Alternative Series","20114176566","Week 2","20114176563","Six Weeks #3"
"20114188076","Implement the plan","20114176223","Board B","20114168785","Alternative Series","20114176565","Week 1","20114176563","Six Weeks #3"
"20114178085","Fix the website","20114176058","Board A","20114169089","Quarterly Planning Series","20114179392","Febuary","20114169189","Qtr 1"
"20114178085","Fix the website","20114176058","Board A","20114169089","Quarterly Planning Series","20114179391","January","20114169189","Qtr 1"

Sample JavaScript AJAX request to export current planning increments

const rootHostUrl = "https://myaccount.leankit.com";
const basePath = `${ rootHostUrl }/io/reporting`;
const auth = {
    email: "my_user@leankit.com",
    password: "my_password",
    accountName: "myaccount"
};
$.ajax(
    {
        method: "POST",
        url: `${ basePath }/auth`,
        success: function( data, textStatus, jqXHR ) {
            const token = JSON.parse( data ).token;
            const dataUrl = `${ basePath }/export/cards/planningincrements?token=${ token }`;
            $.ajax(
                {
                    url: dataUrl,
                    dataType: "text",
                    success: function( cardsResponseData, t2, j2 ) {
                    },
                    error: function( jqXHR, textStatus, errorThrown ) {
                        debugger;
                    }
                } );
        },
        error: function( jqXHR, textStatus, errorThrown ) {
            debugger;
        },
        contentType: "application/json",
        dataType: "text",
        data: JSON.stringify( { email: auth.email, password: auth.password, accountName: auth.accountName } )
    } );