Overview
Pinterest Ads data synced to V4MOS.AI, through the integration's own endpoints
The V4MOS.AI Pinterest Ads API gives you the raw records synced from the Pinterest Ads accounts connected to your organization: ad accounts, campaigns, ad groups, ads and their daily analytics. Rows come as they were synced, with the warehouse column names (snake_case), so you can load them straight into your BI. All endpoints use the /v1/pinterest-ads prefix and the same authentication, pagination and response format.
Getting started
Base URL: https://data.v4mos.ai. Every call requires your API credentials and the organizationId — see Authentication.
- Connect Pinterest Ads in app.v4mos.ai (Connected accounts) and wait for the first sync.
- Call any endpoint below with your
organizationId, for exampleGET /v1/pinterest-ads/ad-accounts?organizationId=…. - Every row carries
integration_idandintegration_name: the connected account it came from. To read a single account, pass that value asintegrationId.
Available endpoints
- getAd accounts
/v1/pinterest-ads/ad-accountsOne row per ad account: name, country and currency. - getCampaigns
/v1/pinterest-ads/campaignsOne row per campaign: status and objective. - getAd groups
/v1/pinterest-ads/ad-groupsOne row per ad group, with its campaign and status. - getAds
/v1/pinterest-ads/adsOne row per ad, with its ad group, campaign and status. - getCampaign analytics
/v1/pinterest-ads/campaigns-analyticsOne row per campaign per day: spend, impressions and clicks, plus every other metric Pinterest reports in metrics (JSON). - getAd group analytics
/v1/pinterest-ads/ad-groups-analyticsOne row per ad group per day: spend, impressions and clicks, plus every other metric Pinterest reports in metrics (JSON). - getAd analytics
/v1/pinterest-ads/ads-analyticsOne row per ad per day: spend, impressions and clicks, plus every other metric Pinterest reports in metrics (JSON).
Resources
| Endpoint | What one row is | dateFrom / dateTo filter |
|---|---|---|
GET /v1/pinterest-ads/ad-accounts | One row per ad account: name, country and currency. Times are epoch seconds. | — |
GET /v1/pinterest-ads/campaigns | One row per campaign: status and objective. | — |
GET /v1/pinterest-ads/ad-groups | One row per ad group, with its campaign and status. | — |
GET /v1/pinterest-ads/ads | One row per ad, with its ad group, campaign and status. | — |
GET /v1/pinterest-ads/campaigns-analytics | One row per campaign per day: spend, impressions and clicks, plus every other metric Pinterest reports in metrics (JSON). | date |
GET /v1/pinterest-ads/ad-groups-analytics | One row per ad group per day: spend, impressions and clicks, plus every other metric Pinterest reports in metrics (JSON). | date |
GET /v1/pinterest-ads/ads-analytics | One row per ad per day: spend, impressions and clicks, plus every other metric Pinterest reports in metrics (JSON). | date |
Pagination and filters
page(default 1) andlimit(default 500, max 5000).meta.hasNextPagesays whether another page exists; rows come in a stable order, so walk the pages until it isfalse.dateFrom/dateTo(YYYY-MM-DD, inclusive) filter by the date column shown in the table above. Resources without one reject them.integrationIdkeeps the rows of one connected account.- Answers are cached for 30 minutes and the data is synced once a day — see Data sync.
Response format
{
"data": [{ "...": "one object per row, with the columns listed on each endpoint" }],
"meta": {
"page": 1,
"limit": 500,
"hasNextPage": true,
"hasPreviousPage": false
}
}Amounts and large counters (fields with format: decimal or format: int64 in each endpoint schema) come as strings, e.g. "125.50", so no precision is lost. Convert them to a decimal type on your side.