PIpinterest
leads_export

Create a request to export leads collected from a lead ad

Changed on

This feature is currently in beta and not available to all apps. If you're interested in joining the beta, please reach out to your Pinterest account manager.

Create an export of leads collected from a lead ad. This returns a leads_export_id token that you can use to download the export when it is ready.

Note: Lead ad data will be available up to 30 days after the lead has been submitted.

For more, see Lead ads.

post/ad_accounts/{ad_account_id}/leads_export

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

ad_idstring required

ID for the ad collecting leads.

end_datestring required

Export leads collected on and before end date (UTC). Format: YYYY-MM-DD.

start_datestring required

Export leads collected on and after start date (UTC). Format: YYYY-MM-DD.

Example request

{
  "ad_id": "687201361754",
  "end_date": "2020-12-20",
  "start_date": "2020-12-20"
}

Response

The request has succeeded.

leads_export_idstring

ID for the leads export job.

Example response

{
  "leads_export_id": "123456789012"
}

Changes

  • v5b698c180678aRevision changes
    • warning

      changed the pattern of the request property from ^(\d{4})-(\d{2})-(\d{2})$ to ^\d{4}-\d{2}-\d{2}$

    • warning

      changed the pattern of the request property from ^(\d{4})-(\d{2})-(\d{2})$ to ^\d{4}-\d{2}-\d{2}$

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response optional property became read-only for the status

    • info

      added the success response with the status

  • v589c27ed39cfdRevision changes
    • info

      endpoint added