API (Application Programming Interface): A way to request data directly from a platform using a structured URL, bypassing the visual dashboard. You send a request with specific parameters and receive raw, structured data back.
Endpoint: The URL path that points to a specific type of data within a platform's API. For example, /v3/domain/analytics targets domain-level visibility metrics.
Parameters: The details you include in your request to specify what data you want. Some are required (the call fails without them), others are optional (the API uses defaults if you omit them).
API Key: A unique string of characters that acts as your password for API access. Included with every request so the platform knows who is asking and that they are authorized.
Pull vs. Push: Pull reads data out of a platform (retrieving keyword rankings, ad spend). Push writes data back into a platform (adding a negative keyword, creating a CRM contact). Push is what turns an API from a reporting tool into an operational one.
Every API call has three parts:
Reading API documentation:
Common error codes:
429 - Rate limit hit. You're sending too many requests. Wait a few seconds and retry.404 - Wrong endpoint URL. Check the docs for the correct path.401 - Authentication failed. Your API key is missing, expired, or incorrect. Regenerate it.Where to find your API key:
How APIs fit into agent workflows: The API call is typically one of the first nodes. It gathers live data, then passes structured fields and values downstream to comparison, detection, diagnosis, or composition nodes. No parsing or extraction needed because the response is already structured.
API (Application Programming Interface): A way to request data directly from a platform using a structured URL, bypassing the visual dashboard. You send a request with specific parameters and receive raw, structured data back.
Endpoint: The URL path that points to a specific type of data within a platform's API. For example, /v3/domain/analytics targets domain-level visibility metrics.
Parameters: The details you include in your request to specify what data you want. Some are required (the call fails without them), others are optional (the API uses defaults if you omit them).
API Key: A unique string of characters that acts as your password for API access. Included with every request so the platform knows who is asking and that they are authorized.
Pull vs. Push: Pull reads data out of a platform (retrieving keyword rankings, ad spend). Push writes data back into a platform (adding a negative keyword, creating a CRM contact). Push is what turns an API from a reporting tool into an operational one.
Every API call has three parts:
Reading API documentation:
Common error codes:
429 - Rate limit hit. You're sending too many requests. Wait a few seconds and retry.404 - Wrong endpoint URL. Check the docs for the correct path.401 - Authentication failed. Your API key is missing, expired, or incorrect. Regenerate it.Where to find your API key:
How APIs fit into agent workflows: The API call is typically one of the first nodes. It gathers live data, then passes structured fields and values downstream to comparison, detection, diagnosis, or composition nodes. No parsing or extraction needed because the response is already structured.