Skip to content

Treemap on Payments by Company

Ksenyia edited this page Feb 1, 2017 · 2 revisions

Getting tree map on payments by company.

Resource URI

treemap?{filters}

Resource Properties

Parameter Description
filters Filter by transfer_unit, transfer_year. Eg. treemap?transfer_unit=USD&transfer_year=2015
{
   errorList: Array,
   sunburstNew: [
       {
           children: [
                        {
                             name: String,
                             children: Array,
                             size: Integer,
                             value: Integer
                        }
                     ],
           name: String,
           size: String,
           total_value: String,
           value: String
        }
   ],
   filters: [
       {
           currency_selector: [
               { 
                   _id: String,
                   name: String 
               }
           ],
           year_selector: [
               { 
                   _id: String,
                   name: String 
               }
           ]
       }
   ],
   total: [
       {
           _id: String,
           currency: String,
           total_value: String
       }
   ]
}

HTTP GET

Default Request

curl -GET http://end-point-uri/treemap?transfer_unit=USD&transfer_year=2015

Response

HTTP Status Code 200

{
   errorList: Array,
   sunburstNew: [
       {
           children: [
                        {
                             name: "Kosmos Energy",
                             children: [
                                 { 
                                     _id: "581b5b59cab60b000f20d038",
                                     children: [
                                         {
                                             name: "License fees, rental fees, entry fees, and other considerations 
                                                    for licenses and/or concessions",
                                             size: 42000,
                                             value: 42000
                                         },
                                         ...
                                     ]
                                     name: "FEL 1/13",
                                     size: 50000,
                                     transfer_value: 50000,
                                     value: 50000  
                                 },
                                 ...
                             ],
                             size: 1199090,
                             value: 1199090
                        }
                     ],
           name: "Payments",
           size: 56296119249,
           total_value: "56296.1",
           value: "56296.1"
        }
   ],
   filters: [
       {
           currency_selector: [
                   {  
                       _id: "xBBL",
                       name: "xBBL"
                   },
                   ...
           ],
           year_selector: [
                   {  
                       _id: "2015",
                       name: "2015"
                   },
                   ...
           ],
      }
   ],
   total: [
       {
           currency: "NOK",
           total_value: "236198.3"
       },
       ...
   ]
}
Clone this wiki locally