API Reference

Run Script

Execute an automation script with the specified arguments

POSThttps://api.syntermedia.ai/v1/tools/run

Request body

script_namestringrequired

Name of the script to execute

argsstring[]

Optional arguments to pass to the script

platformstring

Platform override (GOOGLE, META, LINKEDIN, REDDIT, etc.)

Example request

bash

curl -X POST https://api.syntermedia.ai/v1/tools/run \
  -H "X-Synter-Key: syn_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "script_name": "pull_google_ads_performance",
    "args": ["--days", "7"]
  }'

Example response

json

{
  "success": true,
  "result": {
    "campaigns": [
      {
        "id": "123456789",
        "name": "Brand - Search",
        "status": "ENABLED",
        "metrics": {
          "clicks": 1234,
          "impressions": 45678,
          "cost": 567.89
        }
      }
    ]
  },
  "credits_used": 1
}

Common scripts

Script	Description	Credits
`list_campaigns`	List all campaigns	1
`pull_google_ads_performance`	Get Google Ads metrics	1
`pull_meta_ads_performance`	Get Meta Ads metrics	1
`pull_linkedin_ads_performance`	Get LinkedIn Ads metrics	1
`pause_campaign`	Pause a campaign	5
`update_campaign_budget`	Update budget	5

Was this page helpful?

PreviousAuthentication Next List Campaigns