Get Leads by Time Period

Use Popl APIs to get all leads that were collected by an individual or team within a certain time period.

Individuals

• Get all leads within time range: Get all leads that were collected by an individual between a specific date range.

POST https://us-central1-poplco.cloudfunctions.net/getLeadsTimeRange

{
    "apikey": "{your_api_key}",
    "start": {epoch_date_int},
    "end": {epoch_date_int}
}

• start (integer) required

  • The starting date in epoch form for the date range. This parameter is required. This value should be a milliseconds epoch date such as:

1678237877897

• end (integer)

  • The ending date in epoch form for the date range. If no end parameter is passed in, the API will return all leads from the start parameter onward. This value should be a milliseconds epoch date such as:

1678242973833

Note: Make sure both the start and end parameters are passed in as integers, not strings.

Make sure the call is a POST request and to replace the {your_api_key} with your actual api key provided to you via email from us.

Teams

• Get all leads for an entire team, within a provided time range: Get all leads that were collected by any member on a Popl Teams team, between a specific date range.

POST https://us-central1-poplco.cloudfunctions.net/getLeadsTimeRangeForTeam

{
    "apikey": "{your_api_key}",
    "start": {epoch_date_int},
    "end": {epoch_date_int}
}

• start (integer) required

  • The starting date in epoch form for the date range. This parameter is required. This value should be a milliseconds epoch date such as:

1678237877897

• end (integer)

  • The ending date in epoch form for the date range. If no end parameter is passed in, the API will return all leads from the start parameter onward. This value should be a milliseconds epoch date such as:

1678242973833

Note: Make sure both the start and end parameters are passed in as integers, not strings.

Make sure the call is a POST request and to replace the {your_api_key} with your actual api key provided to you via email from us. Reminder: the api key must be requested by a Popl Teams admin in order for the lead data to be team wide.

Understanding the Response

[
    {
        "note": "Tap the 'Scan' tab below to scan business cards!",
        "jobTitle": "Head of Strategy",
        "epoch": 1687457493613,
        "noPopl": true,
        "fullContact": {
            "twitter": "https://twitter.com/poplco",
            "linkedin": "https://www.linkedin.com/in/jeremywgreenfield/"
        },
        "long": "-122.416389",
        "isRoll": true,
        "isScan": true,
        "number": "9293901919",
        "name": "Example Card Scan",
        "company": "Reach TV",
        "location": "San Francisco, CA",
        "id": "1547",
        "time": "Thursday, 1/28 2021",
        "card": "exampleCard.HEIC",
        "email": "[e-mail]",
        "lat": "37.78",
        "userId": 4822,
        "userEmail": "[e-mail]",
        "userPid": "1"
    },
    {
        "image": "4822-icon-1631833965293687578.jpg",
        "note": "Welcome to Popl! Tap the connect with me button on my profile to say hi",
        "isLead": true,
        "apptoapp": true,
        "jobTitle": "CEO",
        "bio": "Love talking to anyone using Popl. Connect with me below!",
        "epoch": 1687457493813,
        "pro": "1",
        "long": "-118.40403025356767",
        "url": "https://poplme.co/jason",
        "mode": "1",
        "number": "5108478748",
        "pops": "12447",
        "v": "1",
        "name": "Jason - CEO @ Popl",
        "isLoggedIn": "",
        "company": "Default Contact",
        "location": "Los Angeles, CA",
        "id": "4822",
        "time": "Thursday, 1/28 2021",
        "email": "[e-mail]",
        "hash": "R59926fd",
        "lat": "34.0753344218393",
        "views": "18639",
        "userId": 4822,
        "userEmail": "[e-mail]",
        "userPid": "1"
    }
]

The response is returned as a JSON array of lead objects. Each lead object has a unique identified called "id", which can be a integer, email address or phone number, depending on the type of lead and how it was collected.

Each lead also has an "epoch" value that signifies the time in milliseconds that the lead was collected. The response by default returns leads sorted by this "epoch" value.

Each lead object also has multiple values that correspond to the Popl user that collected the lead:

• userId: The unique id of the Popl user that collected the lead

• userEmail: The unique email of the Popl user that collected the lead

• userPid: The profile id that corresponds to the Popl user's profile ID that was shared with the lead.

Each lead may also contain latitude and longitude information which when plotted on a map shows the precise location of where the meeting occurred. This data must be approved by the lead at the time of collection, otherwise, it will not be added to the lead object.

Check out Popl Teams to instantly create high-converting digital business cards for your team.

If any issues or questions, please contact us at [e-mail], we are available nearly 24/7 and will get back to you within 6-8 hours or less.

With 🤍 from Popl.