Skip to content

Proxy Leads

Get proxy leads for a specified period

GET /project/proxy-leads

A method for obtaining proxy leads for a period. 

curl 'https://cloud.roistat.com/api/v1/project/proxy-leads?project=12345&period=2021-07-07-2021-09-24' \
    --request GET \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "ProxyLeads": [
        {
            "id": "2",
            "title": "Callback lead",
            "text": "Call me please",
            "name": "Peter Pan",
            "phone": "71234567890",
            "email": "peter@yahoo.com",
            "roistat": "1000",
            "creation_date": "2016-07-12 14:51:39",
            "order_id": "12346"
        },
        {
            "id": "1",
            "title": "Callback lead",
            "text": "",
            "name": "Alice",
            "phone": "79998887766",
            "email": "alice@yahoo.com",
            "roistat": "1001",
            "creation_date": "2016-07-12 14:10:20",
            "order_id": "12345"
        }
    ],
    "status": "success"
}

Query String:

Parameter Type Description Required
project string Project number yes
period string Time period in YYYY-MM-DD-YYYY-MM-DD format да

Request Body:

No parameters.

Parameter Type Description
ProxyLeads array[object]
> id string Lead ID in Roistat
> title string Lead's title
> text string Detailed information about the lead
> name string Client's name
> phone string Client's phone number
> email string Client's email
> roistat string Visit ID
> creation_date string Lead creation date in UTC0
> order_id string Deal ID from an external system
status string

Get data about a proxy lead by its ID in Roistat

GET /project/proxy-leads/{proxyLeadId}

A method for obtaining data about a proxy lead by ID in Roistat. 

curl 'https://cloud.roistat.com/api/v1/project/proxy-leads/{proxyLeadId}?project=12345' \
    --request GET \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "ProxyLeads": [
        {
            "id": "2",
            "title": "Callback lead",
            "text": "Call me please",
            "name": "Peter Pan",
            "phone": "71234567890",
            "email": "peter@yahoo.com",
            "roistat": "1001",
            "creation_date": "2016-07-12 14:51:39",
            "order_id": "12346"
        },
        {
            "id": "1",
            "title": "Callback lead",
            "text": "",
            "name": "Alice",
            "phone": "79998887766",
            "email": "alice@yahoo.com",
            "roistat": "1000",
            "creation_date": "2016-07-12 14:10:20",
            "order_id": "12345"
        }
    ],
    "status": "success"
}

Query String:

Parameter Type Description Required
project string Project number yes

Request Body:

No parameters.

Parameter Type Description
ProxyLead object
> id string Lead ID in Roistat
> title string Lead's title
> text string Detailed information about the lead
> name string Client's name
> phone string Client's phone number
> email string Client's email
> roistat string Visit ID
> creation_date string Lead creation date in UTC0
> order_id string Deal ID from an external system
status string