Skip to main content

 

Planview Customer Success Center

Advanced Reporting API: Planning Increments Endpoint

GET /io/reporting/export/planningincrements

Returns all the current planning series and increments data.

Resource URL

GET https://{accountname}.leankit.com/io/reporting/export/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/planningincrements?token=xyxyz

Response

Column Description
Planning Series Id  
Planning Series Label  
Parent Planning Increment Id  
Parent Planning Increment Label  
Parent Planning Increment Start Date  
Parent Planning Increment End Date  
Planning Increment Id  
Planning Increment Label  
Planning Increment Start Date  
Planning Increment End Date  

Example response

Planning Series Id,Planning Series Label,Parent Planning Increment Id,Parent Planning Increment Label,Parent Planning Increment Start Date,Parent Planning Increment End Date,Planning Increment Id,Planning Increment Label,Planning Increment Start Date,Planning Increment End Date
10128147199,Example Planning Series,,,,,10128147200,Example Level One Increment,1/1/22 0:00,1/31/22 0:00
10128147199,Example Planning Series,10128147200,Example Level One Increment,1/1/22 0:00,1/31/22 0:00,10128147201,1st child,1/1/22 0:00,1/15/22 0:00
10128147199,Example Planning Series,10128147200,Example Level One Increment,1/1/22 0:00,1/31/22 0:00,10128147202,2nd child,1/16/22 0:00,1/31/22 0:00

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/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 } )
    } );