Ad Accounts

The AdsAccount Object

Properties

idstring

The Rutter generated unique ID of the ad account.

platform_idstring

The platform specific ID of the ad account.

parent_idstringnullable

The Rutter ID of the parent ad account.

namestringnullable

The name of the ad account.

created_atstringnullable

The ISO 8601 timestamp that the ad account was created.

updated_atstringnullable

The ISO 8601 timestamp that the ad account was last updated.

last_synced_atstring

The ISO 8601 timestamp when the ad account was last synced by Rutter.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/ads/accounts

GET

/ads/accounts/:id

List Ad Accounts

GEThttps://production.rutterapi.com/versioned/ads/accounts

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

last_synced_at_minintegerqueryOptional

Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

sortstringqueryOptional

Used to sort the returned objects, e.g. last_synced_at ASC. Currently supports the fields: updated_at or last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults to updated_at DESC.

updated_at_maxintegerqueryOptional

Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

updated_at_minintegerqueryOptional

Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

Response Body

connectionobject

Show connection attributes

accountsarray

Show accounts attributes

next_cursorstringnullableOptional

Support by integration

Facebook
Google
TikTok

Example Response Body

JSON

1{
2  "connection": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "orgId": "00000000-0000-0000-0000-000000000000",
5    "platform": "NETSUITE"
6  },
7  "accounts": [
8    {
9      "id": "00000000-0000-0000-0000-000000000000",
10      "platform_id": "12345678",
11      "parent_id": "00000000-0000-0000-0000-000000000000",
12      "name": "Ads Account",
13      "created_at": "2023-01-02T02:34:56.000Z",
14      "updated_at": "2023-01-02T02:34:56.000Z",
15      "last_synced_at": "2023-01-02T02:34:56.000Z",
16      "platform_data": {
17        "id": 123,
18        "data": "Varies by platform"
19      }
20    }
21  ],
22  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
23}

Fetch an Ad Account

GEThttps://production.rutterapi.com/versioned/ads/accounts/:id

Endpoint Not Available for Version 2023-03-14

The endpoint Fetch an Ad Account (GET /ads/accounts/:id) is not available in version 2023-03-14. The endpoint may be available in a prior or later version. To see API version history, please visit the API Upgrades page.

Have questions?

Contact support for personalized guidance.

Contact support