diff --git a/.gitbook/assets/Census Profile API Postman Collection.zip b/.gitbook/assets/Census Dataset API Postman Collection.zip similarity index 100% rename from .gitbook/assets/Census Profile API Postman Collection.zip rename to .gitbook/assets/Census Dataset API Postman Collection.zip diff --git a/SUMMARY.md b/SUMMARY.md index d7a8e2c1..8dd4bb0c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -46,7 +46,7 @@ * [Digital Markets Act (DMA) Consent for Ad Platforms](basics/security-and-privacy/dma-consent-for-ad-platforms.md) * [Developers](basics/developers/README.md) * [GitLink](basics/developers/gitlink.md) - * [Profile API](basics/developers/entity-api.md) + * [Dataset API](basics/developers/entity-api.md) * [Custom Destination API](basics/developers/custom-api.md) * [Management API](basics/developers/api.md) * [Census Embedded](basics/census-embedded.md) diff --git a/basics/audience-hub/syncing-segments.md b/basics/audience-hub/syncing-segments.md index b4324d70..261439f2 100644 --- a/basics/audience-hub/syncing-segments.md +++ b/basics/audience-hub/syncing-segments.md @@ -80,6 +80,6 @@ In this case, the entity has a dynamic value called **Segment Membership** that

Sync "Segment Membership" from the parent entity.

-You can also sync this field to make segment memberships available via the [Profile API](../developers/entity-api.md). +You can also sync this field to make segment memberships available via the [Dataset API](../developers/entity-api.md). Syncing Segment Memberships will recalculate segment membership across all syncs for that entity at sync time so depending on the number of segments created, this can slow down your sync. diff --git a/basics/developers/README.md b/basics/developers/README.md index dcd16918..12991648 100644 --- a/basics/developers/README.md +++ b/basics/developers/README.md @@ -6,7 +6,7 @@ description: Learn more about all the ways to programmatically control Census Census supports several different APIs for controlling, accessing data, and extending Census. Teams that have the ability to write code can quickly customize Census and make it an even more integrated component of your data infrastructure. -* [Profile API](entity-api.md) - An optional REST API for accessing data stored in your [Entities](../data-models-and-entities/entities.md) on demand. +* [Dataset API](entity-api.md) - An optional REST API for accessing data stored in your [Datasets](../data-models-and-entities/entities.md) on demand. * [Management API](api.md) - A REST API for controlling the Syncs, Models, and Connections configured within Census. This can be used to programmatically read information and perform most actions available in the Census app today. * [Custom Destination API](custom-api.md) - A rich JSON-RPC API for implementing your own custom destination for Census Syncs. This API supports batching and schemas just like other Census connections. * If you're looking for an easy way to send data to a custom destination, you may also want to look at Census's [webhook.md](../../destinations/webhook.md "mention") connector. diff --git a/basics/developers/entity-api.md b/basics/developers/entity-api.md index 247ff686..7684adf5 100644 --- a/basics/developers/entity-api.md +++ b/basics/developers/entity-api.md @@ -1,12 +1,11 @@ --- description: >- - Unleash your entity graph and use your data to power apps far beyond your data - warehouse. + Turn your datasets into an API with a single click to power real-time personalization and recommendations. --- -# Profile API +# Dataset API -Profile API is designed to make your Entities even more valuable by making them easily accessible to the wider app ecosystem. In addition to using **Census Syncs** to push data to destinations, you can now make your data available to be pulled by your applications. +Dataset API is designed to make your datasets even more valuable by making them easily accessible to the wider app ecosystem. In addition to using **Census Syncs** to push data to destinations, you can now make your data available to be pulled by your applications. This opens your data to a whole world of data integration possibilities. A few of the most exciting ones include: @@ -17,20 +16,20 @@ This opens your data to a whole world of data integration possibilities. A few o ## **Set up** {% hint style="info" %} -Profile API is available for customers on the Enterprise Plan. +Dataset API is available for customers on the Enterprise Plan. {% endhint %} -The Profile API can be enabled for each Census workspace individually. Once enabled, all Entities within that workspace will be available via the API. +The Dataset API can be enabled for each Census workspace individually. Once enabled, all datasets within that workspace will be available via the API.
-In order to power the API and make responses quick, Census will automatically cache your entity data on Census managed infrastructure. This process will take a few minutes to hours for extremely large data sets when first enabling the Profile API. Going forward, Census will periodically refresh the cache with incremental changes, just like a typical Census sync. This means that some new data may not be immediately available for querying via the Profile API until the cache is refreshed. +In order to power the API and make responses quick, Census will automatically cache your datasets on Census managed infrastructure. This process will take a few minutes to hours for extremely large datasets when first enabling the API. Going forward, Census will periodically refresh the cache with incremental changes, just like a typical Census sync. This means that some new data may not be immediately available for querying via the Dataset API until the cache is refreshed. -Note that this data will be stored in Census infrastructure until the Profile API is disabled. To learn more about how Census handles your data, see our [Security & Privacy](../security-and-privacy/) page. +Note that this data will be stored on Census infrastructure until the Dataset API is disabled. To learn more about how Census handles your data, see our [Security & Privacy](../security-and-privacy/) page. -## Using Profile API Endpoints +## Using Dataset API Endpoints -**Authentication** - Uses same key as the [Management API](api.md) - This means you shouldn’t use it directly in public code such as javascript on your website. You’ll want to access it server side instead so the key doesn’t leak. A given API key is scoped to a single [Census Workspace](../security-and-privacy/workspaces-and-access-controls.md) and all entities within that workspace will be accessible. +**Authentication** - Uses the same key as the [Management API](api.md). This means you shouldn’t use it directly in public code such as javascript on your website. You’ll want to access it server side instead so the key doesn’t leak. A given API key is scoped to a single [Census Workspace](../security-and-privacy/workspaces-and-access-controls.md) and all datasets within that workspace will be accessible. API requests should include a standard authentication header of the form: @@ -38,18 +37,18 @@ API requests should include a standard authentication header of the form: Authentication: bearer ``` -The Profile API provides two endpoints: +The Dataset API provides two endpoints: -* List Entities - Provides the set of all entities available via the API -* Get Entity Record - Retrieve a specific record of an entity based on its primary key. +* List Datasets - Provides the set of all datasets available via the API +* Get Dataset Record - Retrieve a specific record of a dataset based on its primary key. You can also access these APIs directly with our Postman collection. -{% file src="../../.gitbook/assets/Census Profile API Postman Collection.zip" %} +{% file src="../../.gitbook/assets/Census Dataset API Postman Collection.zip" %} -### List Entities +### List Datasets -The List Entities endpoint will return a list of entities that are available through the API as well as their ID which can then be used to construct a query for specific records of an entity type. +The List Datasets endpoint will return a list of datasets that are available through the API as well as their ID which can then be used to construct a query for specific records of a dataset type. ``` GET https://app.getcensus.com/api/v1/entities @@ -79,9 +78,9 @@ Response } ``` -### Get Entity Record +### Get Dataset Record -Each entity has its own API endpoint, specific to each. You can see the API on the entities page. You can look up any record of your entity by providing the `record_id`, which will look up the record by matching against the Primary ID column selected in the Entity definition. +Each dataset has its own API endpoint. You can see the API on the datasets page. You can look up any record of your dataset by providing the `record_id`, which will look up the record by matching against the Primary ID column selected in the dataset definition. The URL will be of the form: diff --git a/basics/security-and-privacy/README.md b/basics/security-and-privacy/README.md index 1ee91b13..9eb46d9f 100644 --- a/basics/security-and-privacy/README.md +++ b/basics/security-and-privacy/README.md @@ -105,7 +105,7 @@ Also, the following data sources _only_ support Basic Sync Engine (as of March 2 * MySQL * SingleStore -Finally, enabling the Profile API requires us to store the relevant data on our own infrastructure. Census will remove any data stored on your behalf after 14 days of disabling this feature. +Finally, enabling the Dataset API requires us to store the relevant data on our own infrastructure. Census will remove any data stored on your behalf after 14 days of disabling this feature. ## 🤔 Have more questions?