POST
/
gads
/
get_google_ads_result
Get Google Ads Result
curl --request POST \
  --url https://public.plai.io/gads/get_google_ads_result \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "userId": "<string>",
  "campaignId": "<string>",
  "startDate": "<string>",
  "endDate": "<string>"
}'
{
  "success": true,
  "results": {
    "success": true,
    "stats": [
      {
        "campaignid": "<string>",
        "campaignName": "<string>",
        "servingStatus": "<string>",
        "advertising_channel_type": "<string>",
        "status": "<string>",
        "avgPosition": "<string>",
        "clicks": "<string>",
        "conversions": "<string>",
        "cost": "<string>",
        "ctr": "<string>",
        "impressions": "<string>",
        "interactions": "<string>",
        "topImpressionPercentage": "<string>",
        "videoViews": "<string>",
        "videoViewRate": "<string>",
        "averageCpv": "<string>",
        "cpm": "<string>",
        "conversionRateRanking": "<string>",
        "costPerConversion": "<string>",
        "dateStart": "<string>",
        "cpc": "<string>",
        "timeUnit": "<string>",
        "spend": "<string>",
        "phone_calls": "<string>",
        "phone_impressions": "<string>",
        "phone_through_rate": "<string>",
        "searchImpressionShare": "<string>",
        "searchBudgetLostImpressionShare": "<string>",
        "searchRankLostImpressionShare": "<string>",
        "primary_status": "<string>",
        "primary_status_reasons": [
          "<string>"
        ],
        "all_conversions": "<string>",
        "all_conversions_value": "<string>",
        "display_spend": "<string>",
        "display_cpc": "<string>",
        "display_costPerConversion": "<string>"
      }
    ],
    "error": "<string>"
  }
}

Request Body

userId
string
required
User ID, If not already created, make a user on create user page first. If already created, retrieve the user ID from get profile page.
campaignId
string
required
Campaign ID
startDate
string
Start Date Format: YYYY-MM-DD, use to filter the results by start date.
endDate
string
End Date Format: YYYY-MM-DD, use to filter the results by end date.

Response

success
boolean
Indicates that the HTTP response was successful (status code 200 OK).
results
object