Version 1.0
Connector Overview: This page documents all 6 actions for the Postadsconnector v1.0.
Authentication
POST Saas Auth Token
/saas-auth-token
Authenticate with the SaaS service by providing an email and password to obtain an authentication token. Use this action before making requests that require authorization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The email address associated with the SaaS account used for authentication. |
|
|
The password for the SaaS account used for authentication. |
Deliverable
GET GET Deliverables
/saas-deliverables
Retrieve a list of deliverables from the SaaS platform, optionally filtered by project, agency, spot, and paginated.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The page number for paginated results, used to specify which page of deliverables to return. |
|
|
The maximum number of deliverables to return per page. |
|
|
The unique identifier of the project to filter deliverables by. |
|
|
The name of the agency to filter deliverables by. |
|
|
The unique identifier of the spot to filter deliverables by. |
|
|
The name of the spot to filter deliverables by. |
|
|
The response format expected from the API (e.g. application/json). |
Traffic (4)
POST DELETE Traffic
/saas-traffic/delete
Delete a specific traffic entry from the SaaS platform by providing its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the traffic entry to delete. |
GET GET Traffics
/saas-traffics
Retrieve a list of traffic entries from the SaaS platform, optionally filtered by deliverable and paginated.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The page number for paginated results, used to specify which page of traffic entries to return. |
|
|
The maximum number of traffic entries to return per page. |
|
|
The unique identifier of the deliverable to filter traffic entries by. |
|
|
The response format expected from the API (e.g. application/json). |
POST POST Traffics
/saas-traffics
Create a new traffic entry in the SaaS platform, optionally specifying the deliverable and providing transformation data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the deliverable to associate with the new traffic entry. |
|
|
The input data to be used for a transformation when creating the traffic entry. |
|
|
The transformation specification that defines how to process the input data. |
POST UPDATE Traffic
/saas-traffic/update
Update an existing traffic entry in the SaaS platform by providing its identifier and optionally modifying its transformation data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the traffic entry to update. |
|
|
The new input data to be used for a transformation on the updated traffic entry. |
|
|
The transformation specification that defines how to process the input data for the update. |