API method: view_network

This ToldYa API method allows you to retrieve the list of ToldYa users in your network as well as your total network earnings to date. For more information, click here or click the my network button at the top of this page.

Request Method API Endpoint URL
GET http://toldya.com/api/

Required Parameters

Parameter Data Type Length Notes
action string   view_network
api_key string   Your API key

Optional Parameters (show | hide)

Parameter Data Type Length Notes
page_number number max 10 Specify which page of results to return. If not specified, only the first page of results is returned.
page_size number max 100 Specify how many results to return per page. The default is 20.
order_by string   Comma-separated list of columns you want to sort by. If not specified the API will return records sorted by total (lowest first). If you specify more than one column to sort by, the results will be grouped by the first column, then by the second, etc. You can order_by and of the following columns: first_name, last_name, city, state, created, total.

You can also specify the direction of the sorting by passing ASC or DESC as in the following example which returns the highest grossing network seller first: order_by=total%20DESC

Example Requests

Return the first page of 20 network users sorted by highest earnings first:

http://toldya.com/api/?api_key=xxx&action=view_network&order_by=total%20DESC

Return the 2nd page of network users with 5 users returned per page (will return users 6-10, assuming there are at least 10 users in your network):

http://toldya.com/api/?api_key=xxx&action=view_network&page_size=5&page_number=2

Example Response

The following shows example XML returned by the API for this method. The <network_total> node shows the total money you've earned from all users in your network while the <total> node for each <result> shows the total you earned for that particular User.

<toldyaapiresponse>
    <url>https://www.toldya.com/api/?api_key=xxx&amp;action=view_network</url>
    <status>SUCCESS</status>
    <message/>
    <total_pages>2</total_pages>
    <page_number>1</page_number>
    <page_size>20</page_size>
    <network_total>36.00</network_total>
    <network>
        <result>
            <total>16.00</total>
            <first_name>Philip</first_name>
            <last_name>Smith</last_name>
            <city>Corning</city>
            <state>NY</state>
            <company>Phil&apos;s Stuff</company>
            <is_verified/>1</is_verified>
            <url>www.myspace.com/phil</url>
            <url_image/>
            <created>01/01/2009</created>
        </result>
		<result>
            <total>20.00</total>
            <first_name>Josh</first_name>
            <last_name>Jones</last_name>
            <city>Miami</city>
            <state>FL</state>
            <company></company>
            <is_verified/>
            <url/>
            <url_image/>
            <created>01/01/2009</created>
        </result>
    </network>
</toldyaapiresponse>

 


back to top