Sharing Data with Clients

How to integrate data on behalf of clients

By default, uploading data to Scope3 is private. To share data with a client:

  1. Data is uploaded with a client identifier
  2. The client identifier is mapped to the client's Scope3 account
  3. The client is given permission to see the data

Client Identifiers

The GMP Upload and Media Delivery APIs support client identifiers using the client field.

Client identifiers show up in your reporting and not your client's reporting, so you can choose them for clarity and convenience. It is probably easiest to use the advertiser name as it shows up in your ad management platforms, like Unilever c/o Mindshare Ultra, but an ID would work as well.

The client identifier should be passed into every record uploaded on behalf of the client. The client identifier does not need to be mapped at the time of upload.

Mapping Client Identifiers to Scope3 Accounts

Scope3 maintains a mapping table of client identifiers to Scope3 accounts. An identifier can map to multiple accounts to enable both an agency and an advertiser to see the data. For instance, in the example above, you might map Unilever c/o Mindshare Ultra to [Unilever, Mindshare Ultra].

To see and update the current client-account mappings, use the Account Mapping API or the Account Mapping tool in your scope3.com account, both coming soon.

GET /path-to-account-mapping
{"clients":
  [
	{"client": "Unilever c/o Mindshare Ultra",
   "apis": ["traffic"],
   "last_seen": "2023-09-07",
   "mapped_accounts": []
  },
{"client": "Pepsi",
   "apis": ["media_delivery"],
   "last_seen": "2023-09-01",
   "mapped_accounts": [{"id": 27, "name": "Pepsico", "access": "none"}]
  }
 ]
}

If a Scope3 account is not found for a client, please ask them to register for a Scope3.com account. The Scope3 team can help write invitation emails, provide status on registration, and bulk map accounts to client identifiers.

Setting Permissions

Scope3 has three permission settings for each mapped client:

  • See nothing
  • See everything
  • Transaction-specific (configured using the Deals API)

These settings are managed using the Account Mapping API.

POST /path-to-account-mapping/
{"client": "Unilever c/o Mindshare Ultra",
  "mapped_accounts": [
     {"id": 1234, "access": "per-transaction"},
	   {"id": 5678, "access": "full"}
  ]
}