Getting the Dataset of a Report Element

Usage

Returns the data of a report element.

You may use a specific datapath or reference of a report element to retrieve its data.

Request

GET /documents/<documentID>/reports/<reportID>/elements/<elementID>/dataset?<optional_parameters>

Table 1: Optional Parameters
Parameter Description
datapath A string that specifies a datapath, which allows you to find a specific instance of a report element, for example dataset?datapath=DP1.DObc:"2004",DP1.DOa6:"Austin".
reference A string that specifies a reference, for example dataset?reference=1.D.7.
Caution You cannot use datapath and reference parameters in the same URL. This generates a 400 HTTP error.
Response

Response type: application/xml or application/json

Response body: the details of the dataset, which are:

  • The column metadata (name, type, and data object identifier)
  • A list of rows containing the values

Example

Cell

GET /documents/6404/reports/4/elements/7/dataset?reference=4.7.B

Response:

<dataset>
    <metadata>
        <value dataObjectId="DP1.DO93" type="Numeric">Sales revenue</value>
    </metadata>
    <row>
        <value>910451.2</value>
    </row>
</dataset>

Example

VTable

The vertical table contains six rows which can display up to five data object values.

GET /documents/6395/reports/1/elements/78/dataset

Response:

<dataset>
    <metadata>
        <value dataObjectId="DP1.DO84" type="String">Country</value>
        <value dataObjectId="DP1.DO2" type="String">Resort</value>
        <value dataObjectId="DP1.DO5" type="String">Service</value>
        <value dataObjectId="DP1.DO14" type="Numeric">Number of guests</value>
        <value dataObjectId="DP1.DO7" type="Numeric">Revenue</value>
    </metadata>
    <row>
        <value>Bahamas Islands</value>
        <value>Bahamas Beach</value>
        <value>Activities</value>
        <value/>
        <value>65600</value>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>Bahamas Beach</value>
        <value>Bungalow</value>
        <value>48</value>
        <value>47040</value>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>Sun Resort</value>
        <value>Activities</value>
        <value/>          
        <value>9000</value>
     </row>
     <row>
        <value>Bahamas Islands</value>
        <value>Sun Resort</value>
        <value>Bungalow</value>
        <value>44</value>
        <value>40800</value>
     </row>
     <row>
        <value>Bahamas Islands</value>
        <value>Hawaiian Club</value>
        <value>Activities</value>
        <value/>
        <value>101100</value>
     </row>
     <row>
        <value>Bahamas Islands</value>
        <value>Hawaiian Club</value>
        <value>Bungalow</value>
        <value>45</value>
        <value>56100</value>
     </row>
</dataset>

Example

HTable

The horizontal table contains six columns that can display up to three data object values.

GET /documents/6361/reports/3/elements/101/dataset

Response (JSON):

{"dataset":
    {"metadata":
        {"value":
            [{"@dataObjectId":"DP0.DOa5",
              "@type":"String",
              "$":"Region"},
             {"@dataObjectId":"DP0.DOa7",
              "@type":"String",
              "$":"City"},
             {"@dataObjectId":"DP0.DO14",
              "@type":"Numeric",
              "$":"Number of guests"}]
        },
     "row":
        [{"value":["Bavaria","Augsburg",191]},
         {"value":["Bavaria","Munich",132]},
         {"value":["East Germany","Berlin",6]},
         {"value":["East Germany","Dresden",4]},
         {"value":["East Germany","Magdeburg",133]},
         {"value":["Ruhr","Cologne",4]}]
    }
}

Example

XTable

The cross table displays the values of six data objects.

GET /documents/6395/reports/3/elements/19/dataset

Response:

<dataset>
    <metadata>
        <value dataObjectId="DP1.DO84" type="String">Country</value>
        <value dataObjectId="DP1.DOa7" type="String">City</value>
        <value dataObjectId="DP1.DO2" type="String">Resort</value>
        <value dataObjectId="DP1.DO5" type="String">Service</value>
        <value dataObjectId="DP1.DO7" type="Numeric">Revenue</value>
        <value dataObjectId="DP1.DO14" type="Numeric">Number of guests</value>
    </metadata>
    <row>
        <value>Bahamas Islands</value>
        <value>Coral Bay</value>
        <value>Bahamas Beach</value>
        <value>Activities</value>
        <value>5600</value>
        <value/>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>Long Island</value>
        <value>Bahamas Beach</value>
        <value>Bungalow</value>
        <value>3200</value>
        <value>4</value>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>Nassau</value>
        <value>Bahamas Beach</value>
        <value>Bungalow</value>
        <value>43840</value>
        <value>44</value>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>Nassau</value>
        <value>Sun Resort</value>
        <value>Bungalow</value>
        <value>40800</value>
        <value>44</value>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>Nassau</value>
        <value>Hawaiian Club</value>
        <value>Bungalow</value>
        <value>56100</value>
        <value>45</value>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>San Salvador</value>
        <value>Bahamas Beach</value>
        <value>Activities</value>
        <value>60000</value>
        <value/>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>San Salvador</value>
        <value>Sun Resort</value>
        <value>Activities</value>
        <value>9000</value>
        <value/>
    </row>
    <row>
        <value>Bahamas Islands</value>
        <value>San Salvador</value>
        <value>Hawaiian Club</value>
        <value>Activities</value>
        <value>101100</value>
        <value/>
    </row>
</dataset>

Example

Chart

The chart displays three data object values.

GET /documents/6405/reports/1/elements/13/dataset?datapath=DP1.DOa6:"New York"

Response (XML):

<dataset>
    <metadata>
        <value dataObjectId="DP1.DO178" type="String">Store name</value>
        <value dataObjectId="DP1.DObc" type="String">Year</value>
        <value dataObjectId="DP1.DO93" type="Numeric">Sales revenue</value>
    </metadata>
    <row>
        <value>e-Fashion New York 5th</value>
        <value>2004</value>
        <value>644635.1</value>
    </row>
    <row>
        <value>e-Fashion New York 5th</value>
        <value>2005</value>
        <value>1.076144e6</value>
    </row>
    <row>
        <value>e-Fashion New York 5th</value>
        <value>2006</value>
        <value>1.2395874e6</value>
    </row>
    <row>
        <value>e-Fashion New York Magnolia</value>
        <value>2004</value>
        <value>1.0230607e6</value>
    </row>
    <row>
        <value>e-Fashion New York Magnolia</value>
        <value>2005</value>
        <value>1.6873591e6</value>
    </row>
    <row>
        <value>e-Fashion New York Magnolia</value>
        <value>2006</value>
        <value>1.9114343e6</value>
    </row>
</dataset>

Example

Chart

The chart displays five data object values.

GET /documents/6404/reports/4/elements/16/dataset

Response (JSON):

{"dataset":
    {"metadata":
        {"value":
            [{"@dataObjectId":"DP1.DOda","@type":"String","$":"State"},
             {"@dataObjectId":"DP1.DOa6","@type":"String","$":"City"},
             {"@dataObjectId":"DP1.DO178","@type":"String","$":"Store name"},
             {"@dataObjectId":"DP1.DO93","@type":"Numeric","$":"Sales revenue"},
             {"@dataObjectId":"DP1.DO94","@type":"Numeric","$":"Quantity sold"}]
        },
     "row":
        [{"value":["California","Los Angeles","e-Fashion Los Angeles","1.6566757e6",9869]},
         {"value":["California","San Francisco","e-Fashion San Francisco","1.3360033e6",7900]},
         {"value":["Colorado","Colorado Springs","e-Fashion Colorado Springs",843584.2,5116]},
         {"value":["DC","Washington","e-Fashion Washington Tolbooth","1.0535814e6",6491]},
         {"value":["Florida","Miami","e-Fashion Miami Sundance",811923.6,4830]},
         {"value":["Illinois","Chicago","e-Fashion Chicago 33rd","1.1340854e6",6519]},
         {"value":["Massachusetts","Boston","e-Fashion Boston Newbury",887169.2,5269]},
         {"value":["New York","New York","e-Fashion New York 5th","1.2395874e6",7458]},
         {"value":["New York","New York","e-Fashion New York Magnolia","1.9114343e6",11651]},
         {"value":["Texas ","Austin","e-Fashion Austin","1.1354791e6",6919]},
         {"value":["Texas ","Dallas","e-Fashion Dallas",803420.8,4932]},
         {"value":["Texas ","Houston","e-Fashion Houston",910451.2,5419]},
         {"value":["Texas ","Houston","e-Fashion Houston Leighton","1.3357472e6",7923]}]
    }
}