Getting the Samples of a Flow

Returns the data samples of a data provider.

In Web Intelligence, the data samples display in the Query Panel.
Caution The following method is only supported for Microsoft Excel and free-hand SQL data providers.
Request

GET <webiURL>/documents/{documentId}/dataproviders/{dataproviderId}/flows/{flowId}/samples

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • {dataProviderId} is the data provider identifier retrieved from the list of data providers
  • {flowId} is the flow identifier that you can know from the flow count
Response

Response type: application/xml or application/json

The response body contains:

  • The list of the column names with identifiers and data type (<column>)
  • The list of column values for each row of the data samples (<cvalue>)

Example

<samples> 
    <columns> 
        <column id="0" type="String">Country</column>  
        <column id="1" type="String">Region</column>  
        <column id="2" type="String">City</column>  
        <column id="3" type="Numeric">Revenue</column>  
        <column id="4" type="String">Retailer Name</column>  
        ...
    </columns>  
    <cvalues> 
        <cvalue> 
            <column id="0">United States</column>  
            <column id="1">California</column>  
            <column id="2">Los Angeles</column>  
            <column id="3">155000</column>  
            <column id="4">Bedford</column>  
            ...
        </cvalue>  
        <cvalue> 
            <column id="0">United States</column>  
            <column id="1">California</column>  
            <column id="2">Los Angeles</column>  
            <column id="3">120150</column>  
            <column id="4">Jones</column>  
            ... 
        </cvalue>  
        <cvalue> 
            <column id="0">United States</column>  
            <column id="1">California</column>  
            <column id="2">Los Angeles</column>  
            <column id="3">227000</column>  
            <column id="4">Smith</column>  
            ... 
        </cvalue>  
        ...
    </cvalues>
</samples>