# Changelog

All notable changes to our API will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

Until we reach API 1.0, the following special rules apply:

1. If you **add a feature** or **fix a bug**, please bump the version from **0.x.y** to **0.x.(y+1)**.
2. If you **make a breaking change**, please bump the version from **0.x.y** to **0.(x+1).0**.

## [0.15.1] - 2026-07-08

### Added

- `TargetFilter.attribute`: optional list of `TargetFilterAttributeConditions` for filtering a target's exported rows by scope payload attribute columns. Your account must have an identity graph set.

## [0.15.0] - 2026-06-24

### Changed

- **Breaking:** `AnalysisDimensionsTraitBinNumber.min` and `AnalysisDimensionsTraitBinDate.min`
  are now optional — consumers can no longer assume `min` is always present. When omitted, the
  bin is open-ended below its `max`, counting all values below that range (the mirror of an
  omitted `max`, which is open-ended above `min`).

## [0.14.25] - 2026-06-10

### Added

- `Attribute.type` is now writable on create and update (previously read-only).
- `Attribute.statistical_type`: optional `TraitStatisticalType` describing the nature of the attribute's data.
- `Attribute.unit`: optional string giving the units a numeric attribute is stored in.
- `Dataset.output_to_authority`: optional `{ name, date }` that tags a dataset's contents as a dated assertion from a named authority. Available only for vendor accounts.
- `Attribute.sources`: optional effective-dated source configuration nested by authority, source column, and inclusive effective-from date. Each entry sets precision, quality, optional derivations/effective_until, and an optional transform (cast, selector, or decode/recode).

## [0.14.24] - 2026-06-11

### Deprecated

- `GET /persona_sets/{persona_set_id}/analysis/flow` (`getPersonaSetAnalysisFlow`) is now deprecated and no longer maintained.

## [0.14.23] - 2026-06-03

### Added

- `ScopePopulation.exclusion_address_level_cohort_ids`: optional array of cohort UUIDs whose addresses are suppressed from the scope. Useful for direct-mail and other household-level suppression. A new `GET /scopes/{scope_id}/population/exclusion_address_level_cohorts` endpoint returns the resolved `Cohort[]` for a scope.

## [0.14.22] - 2026-05-21

### Added

- `scope_analysis`: residence-level analysis. Six additive, optional fields on `ScopeAnalysisProbabilityDistributionDatum` — `scope_residences`, `eligible_residences` (residence-level proportions) and `scope_individuals_count`, `scope_residences_count`, `eligible_individuals_count`, `eligible_residences_count` (absolute counts) — plus a new `GET /scopes/{scope_id}/analysis/geography` endpoint with `ScopeGeography`, `ScopeGeographyArea`, `ScopeGeographyCohort` schemas returning a postcode- and state-level breakdown with per-payload-cohort counts. `postcodes` is omitted when the scope spans more than 250 distinct postcodes; both geography fields are absent (`{}`) until the analysis has run for the scope.

## [0.14.21] - 2026-05-20

### Added

- `attributes` array and `AnalysisDimensionsAttribute` schema (`attribute_name` + `bins` + `salient`) on the persona set analysis dimensions response (`GET /persona_sets/{persona_set_id}/analysis/dimensions`). Returned instead of `traits` for accounts with an identity graph feature store set (FIG v2). Attribute names are `fig/` prefixed (pattern: `^fig/[a-z][a-z0-9_]+$`).

## [0.14.20] - 2026-05-19

### Added

- `fig/vehicles`, `fig/civic`, `fig/engagement` values for `TraitCategory` enum (already present on `StreamPropertyCategory` since 0.14.11). Fixes prod `GET /v1/streams` 500s on streams in those categories.

## [0.14.19] - 2026-05-08

### Added

- `impute_payload` field on `TargetModesHashed`, `TargetModesIdentified`, and `TargetModesReferenced` representations — array of payload elements to include imputed values for. Defaults to `[]` (off). Pass `["attributes"]` to include attribute values imputed from cohabitants and neighbors; otherwise the target's payload only includes attribute values from rows matched at person-level precision. `TargetModesAggregated` does not support this field.

## [0.14.18] - 2026-05-04

### Added

- `modeling_attributes` field on persona sets and new `ModelingAttribute` enum (29 `fig/*` paths) for accounts with an identity graph feature store set (FIG v2). Mutually exclusive with `modeling_fields`: feature-store accounts must use `modeling_attributes`; non-feature-store accounts must continue to use `modeling_fields`.

## [0.14.17] - 2026-04-30

### Added

- `Target.analysis_config.attributes` optional array of attribute names to include as dimensions in target analysis. Your account must have an identity graph feature store set. Faraday provided attributes must be prefixed with `fig/` ex. `fig/age` (pattern: `^fig/[a-z][a-z0-9_]+$`).
- `TargetAnalysisAttribute` response schema (`attribute_name` + `bins`) returned from `GET /targets/{target_id}/analysis` alongside trait and geography dimensions.

## [0.14.16] - 2026-04-29

### Added

- Optional `limit` field on `AccountUsageTimePeriod` and `AccountUsagePredictiveData` — exposes the customer's yearly contractual limit. Populated only on the rolled-up `/v1/accounts/current/usage/all` endpoint (the per-account endpoints omit it because the contractual limit applies to the parent + sub-accounts total). Omitted when no limit is on record.

## [0.14.15] - 2026-04-28

### Added

- Add read-only `categories` field on `/attributes` endpoint - for categorical data types, the list of distinct category values observed in the stream.

## [0.14.14] - 2026-04-20

### Added

- `attributes` field on cohorts — list of `CohortAttributeCondition` to filter cohort membership by attribute value (supports `_eq`, `_gt`, `_lt`, `_gte`, `_lte`, `_null`, `_nnull`, `_in`, `_nin`, `_matches`, plus `optional` for union semantics).
- `fig/length_of_residence_v2` value for persona set `modeling_fields` enum. `fig/length_of_residence` is deprecated; use `_v2` for new persona sets.

## [0.14.13] - 2026-04-10

### Added

- Add read-only `type` field on `/attributes` endpoint - the data type of the attribute's value property, derived from stream event_stream_properties.

## [0.14.12] - 2026-04-10

### Added

- Add `breaks` on GET `/attributes` endpoint - for continuous data types, list of reasonable cutoff values.

## [0.14.11] - 2026-04-09

### Added

- `binary`, `count`, `interval`, `ratio` values for `TraitStatisticalType` enum.
- `fig/vehicles`, `fig/civic`, `fig/engagement` values for `StreamPropertyCategory` enum.

## [0.14.10] - 2026-04-01

### Added

- `predictors.max_observation_date` optional date field on outcomes and recommenders for release pinning — caps FIG attribute data used during modeling to a specific date.
- `payload.max_attribute_observation_date` optional date field on scopes for release pinning — caps FIG attribute data included in scope output to a specific date.
- `modeling_field_max_observation_date` optional date field on persona sets for release pinning — caps FIG attribute data used in modeling fields to a specific date.

## [0.14.9] - 2026-04-01

### Added

- `sum` and `count_not_null` aggregation methods for `AttributeAggregationMethod`.

## [0.14.8] - 2026-03-26

### Added

- `permissions` read-only array field on `GET /attributes` and `GET /attributes/{id}`. Returns the set of permissions granted for the attribute for the requesting account (e.g. `["add_to_scope_payload"]`).
- `AttributePermission` enum with value `add_to_scope_payload`.

## [0.14.7] - 2026-03-23

### Added

- `identity_graph` field on accounts, indicating which feature store the account uses for retrieving metadata such as attributes.

## [0.14.6] - 2026-03-12

### Added

- GET `/accounts/{account_id}/usage` - returns usage metrics for a specific account. Parent accounts can view sub-account usage; accounts can view their own usage.

## [0.14.5] - 2026-02-10

### Added

- GET `/accounts/current/usage` - returns usage metrics for the current account, including batch deployments, lookup API calls, and predictive data usage.
- GET `/accounts/current/usage/all` - returns aggregated usage metrics across the current account and all sub-accounts.
- `contract_started_at` field on accounts.

## [0.14.4] - 2026-02-20

### Added

- All list endpoints now accept an optional `ids` query parameter to filter results by resource ID. Repeat the parameter for multiple IDs (e.g. `?ids=a&ids=b`), up to 100.

## [0.14.3] - 2026-02-20

### Fixed

- PATCH endpoints now use the RFC 7396 compliant `Content-Type: application/merge-patch+json` header (previously `application/json+merge-patch`). Both headers are accepted for backwards compatibility.

## [0.14.2] - 2026-02-19

### Added

- New `statistical_type` values for streams and traits: `continuous_ordinal`, `categorical_nominal`, `multicategorical_nominal`, `categorical_ordinal`. Legacy values (`categorical`, `multicategorical`, `ordinal`, `nominal`) are still accepted but deprecated.

## [0.14.1] - 2026-02-01

### Added

- GET `/datasets/{dataset_id}/logs/ingress` - returns paginated ingress logs showing row processing metrics (total, processable, valid, allowed, recognized, enrichable counts).
- GET `/datasets/{dataset_id}/logs/ingress/{log_id}` - returns a specific ingress log entry.

## [0.14.0] - 2026-01-29

### Changed

- Made `aggregation` and `default_selector_by_purpose` optional on `/attributes` endpoints (POST, PUT, GET) to match the database schema where these columns are nullable.

## [0.13.1] - 2025-12-12

### Added

- GET/POST/PATCH/DELETE `/attributes` - wraps multiple event_streams 'assertions' into one 'trait' (similar to FIG) usable in modeling, inference, and appends. When multiple assertions are available for a given person, the attribute specifies how to choose the best assertion for each use case.

- GET/POST/PATCH/DELETE `/feature_stores` - a collection of attributes, similar to Faraday's FIG identity graph.

## [0.13.0] - 2025-12-04

### Deprecated

- `/targets` analysis - deprecated all geographies except state and postcode.

## [0.12.0] - 2025-11-11

### Changed

- Changed allowed values for `category` in `/streams` endpoints. Should match the values allowed in `/traits` endpoints.

## [0.11.4] - 2025-10-20

### Added

- Added `interpretation` to `GET /persona_sets/{persona_set_id}`

## [0.11.3] - 2025-10-20

### Deprecated

- In `dataset.identity_sets`, `address_line_1` and `address_line_2` are deprecated. Use `house_number_and_street` array format instead to compose address lines.

## [0.11.2] - 2025-10-02

### Deprecated

- `persona_set.personas[].avatar`

## [0.11.1] - 2025-10-02

### Added

- Added `salient` to `AnalysisDimensionsTrait` to show whether the trait distinguishes the persona from the rest of the persona set.

## [0.11.0] - 2025-09-05

### Breaking

- No longer support zip or tar uploads due to security issues

## [0.10.62] - 2025-09-04

### Changed

- Allow `/` in SFTP dataset prefix

## [0.10.61] - 2025-07-07

### Added

- Added `address_line_1` and `address_line_2` to `dataset.identity_sets`. This means you may now see a recommended column to use in `identifier_recommendation` for `address_line_2` as well.

### Deprecated

- Array-based `house_number_and_street` field in `dataset.identity_sets`. Use `address_line_1` and `address_line_2` instead. If you use all 3, address lines will be prioritized.

## [0.10.60] - 2025-07-02

### Added

- Add `unknown` data type for dataset detected columns when we don't yet support a detected schema type.

## [0.10.59] - 2025-06-23

### Added

- Added a boolean output_multiple_identities to identified and referenced target.representation config - defaults to false.

## [0.10.58] - 2025-06-13

### Added

- Added optional `value` property to output_to_traits on datasets and changed column_name to optional. One or the other must be included and validation will occur at runtime.

## [0.10.57] - 2025-06-09

### Added

- Added `household_income_v2` to allowed modeling fields in persona set creation. `household_income` is deprecated.

## [0.10.56] - 2025-05-29

### Added

- Added `strategies` to `GET /outcomes/{outcome_id}/analysis` and `strategy_id` in the tenure objects, which refers to the strategy used to generate the outcome analysis. This is useful for understanding how the outcome was generated and what modeling techniques were applied.

## [0.10.55] - 2025-05-22

### Changed

- GET /market_opportunity_analyses/{id} - fix typing - certain fields can be floats (eg average attainment value). 'Integer' was too strict.

## [0.10.54] - 2025-05-15

### Added

- POST /{resource_type}/{resource_id}/force_update - allows user to manually rerun a resource (Faraday does this automatically whenever it detects changes, but this option allows the user to 'force' a rerun). If changes are detected as a result of the rerun, downstream resources will also be rerun.

## [0.10.53] - 2025-05-01

### Changed

- POST & PATCH /datasets - clarify which identity set fields are required for matching, and throw an error if insufficient.

## [0.10.52] - 2025-04-08

### Added

- POST /uploads - allow compressed file formats (zip, bz2, gz, tar). The uncompressed file must still be formatted like a csv.

## [0.10.52] - 2025-03-31

### Changed

- POST /uploads - clarify which file types are allowed.

## [0.10.51] - 2025-03-18

### Added

- Added `trait.precision`, which refers to the specificity used to assign a trait.

## [0.10.50] - 2025-03-17

### Added

- Added `coverage` to traits result to show the percentage of the US population that has the trait.

## [0.10.49] - 2025-03-04

### Changed

- Dataset identity set keys/names must start with letter or underscore

## [0.10.48] - 2025-02-25

### Added

- Added `identifier_recommendation` to `dataset.detected_columns`. Useful when configuring dataset `identity_sets`.

## [0.10.47] - 2025-02-18

### Added

- Added `carrier_route` to Target mode aggregate options

## [0.10.46] - 2025-02-14

### Added

- Added `scope.population_residence_count` to show unique residence count for the scope's population. Populated once the scope has built.

## [0.10.45] - 2025-02-05

### Added

- Added new endpoints for target analysis:
  - `GET /targets/{target_id}/anlaysis`: Get target analysis report.
  - `GET /targets/{target_id}/pdf`: Get a signed url redirect to target analysis pdf report
- Added count and analysis_config properties to `POST and PATCH /targets`
- Added branding property to `POST and PATCH /accounts`

## [0.10.44] - 2025-02-03

### Added

- Allow users to create Outcomes, Recommenders, and Persona Sets in `preview` mode, which will cause them not to build immediately.
- Add Outcomes `prediction_mode: auto | static`, which can be used to disable dynamic modeling. Defaults to true.

## [0.10.43] - 2025-01-16

### Added

- Added new endpoints for market opportunity analyses:
  - `POST /market_opportunity_analyses`: Create a new market opportunity analysis.
  - `GET /market_opportunity_analyses`: Get all market opportunity analyses.
  - `GET /market_opportunity_analyses/{market_opportunity_analysis_id}`: Get a specific market opportunity analysis.
  - `PATCH /market_opportunity_analyses/{market_opportunity_analysis_id}`: Update a specific market opportunity analysis.
  - `DELETE /market_opportunity_analyses/{market_opportunity_analysis_id}`: Delete a specific market opportunity analysis.
  - `POST /market_opportunity_analyses/{market_opportunity_analysis_id}/archive`: Archive a specific market opportunity analysis.
  - `POST /market_opportunity_analyses/{market_opportunity_analysis_id}/unarchive`: Unarchive a specific market opportunity analysis.

## [0.10.42] - 2024-12-17

### Added

- Add `/scopes/{scope_id}/efficacy` to return scope payload resource efficacy metrics

## [0.10.41] - 2024-12-09

### Added

- Add `all_individuals` and `unrecognized_individuals` to `GET /outcomes/{outcome_id}/analysis` response

## [0.10.40] - 2024-10-31

### Added

- Add `identity_provider' field to lookup api response to describe which identity provider was used to match the identity.

## [0.10.39] - 2024-10-10

### Added

- Add residence_count to GET /cohorts

## [0.10.38] - 2024-10-10

### Added

- `GET /scopes/{scope_id}/analysis` to return scope payload resource probability distribution

## [0.10.37] - 2024-10-08

### Fixed

- Enable more permissible glob patterns for `prefix` connection options.

## [0.10.36] - 2024-09-30

### Fixed

- Make webhook secrets read-only

## [0.10.35] - 2024-09-26

### Added

- Added `secret` (sha256 signing key) to webhook endpoints

## [0.10.34] - 2024-09-25

### Added

- Webhook endpoints endpoints

## [0.10.33] - 2024-09-24

### Added

- `GET /usages` and `GET /accounts/x/billing` added `name` to each usage

## [0.10.32] - 2024-09-16

### Added

- `GET /traits` and `GET /traits/{id}` added `life_event` category

## [0.10.31] - 2024-09-12

### Added

- `GET /traits` and `GET /traits/{id}` added `deprecated` boolean field for Faraday's traits.

## [0.10.30] - 2024-09-04

### Added

- `GET /traits.csv` to return information about all traits the user has access to, in csv form.
- `GET /traits` and `GET /traits/{id}` added `tier` and `permissions` for each trait.

## [0.10.29] - 2024-08-30

### Added

- `GET /streams/{stream_id_or_name}/analysis` to return event stream analysis (starting with a `time_series`)
- `stream.properties[property].distribution` which is present for numeric properties and contains the distribution of values
- `stream.properties[property].values` which is present for categorical and multicategorical properties and contains the unique values and their counts
- `stream.event_contribution_by_dataset` to show which datasets contributed to the stream and their event count
- `stream.event_count` which is the total number of events in the stream
- `stream.oldest_date` and `stream.newest_date` which are the oldest and newest dates of events found in the stream

## [0.10.28] - 2024-08-26

### Added

- Add yyyy_mm_dash and yyyy_mm_slash to data map date formats

## [0.10.27] - 2024-08-05

### Added

- Add `identity_sets` to lookup api to allow for including multiple identifying information for the same individual, i.e. addresses, emails, phone numbers etc...

## [0.10.26] - 2024-08-01

### Added

- `datasets.output_all_columns_as_traits.include` enables an allowlist for automatically generated traits.

## [0.10.25] - 2024-07-31

### Added

- Added `merge_datasets` to `datasets`. This field contains a list of parent/merge dataset IDs and join columns that use the current dataset as a source.

## [0.10.24] - 2024-07-18

### Added

- `GET /graph` returns 1 new status fields for both upstream and downstream resources for a total of 2 fields: xxx_status_error (where xxx = downstream or upstream)
- Added required to several fields on /graph that were not really optional and always included: id, status, literate, and type

## [0.10.23] - 2024-07-10

### Added

- `POST /{resource_type}/{resource_id}/archive` archive the specified resource. If a resource is archived, it will no longer appear in the Faraday UI (except in the 'archived' tab), and Faraday will no longer update the resource. To archive a resource, all downstream resources must also be archived.

- `POST /{resource_type}/{resource_id}/unarchive` unarchive the specified resource. To unarchive a resource, all upstream resources must also be unarchived.

## [0.10.22] - 2024-07-10

### Added

- `null_values` added to `output_to_traits` to support null transformations.

## [0.10.21] - 2024-07-03

### Added

- `GET /graph` returns 4 new status fields for both upstream and downstream resources for a total of 8 fields: xxx_status_changed_at, xxx_last_updated_output_at, xxx_last_updated_config_at, xxx_last_read_input_at (where xxx = downstream or upstream)

## [0.10.20] - 2024-06-25

### Added

- `GET /recommenders/{recommender_id}/analysis` to return model performance, feature importance, and more.

## [0.10.19] - 2024-06-24

### Fixed

- `GET PATCH POST /connections`: allow slashes in s3 and gcs `bucket_name`
- `PATCH /user_places`: setting a place's `addresses` = null will now delete addresses

### Deprecated

- `GET /datasets`: deprecate match_count. Use `enrichment` instead

## [0.10.18] - 2024-06-12

### Added

- Updated pattern for header_row to match delimiter options and added tab delimiter option '\t'

## [0.10.17] - 2024-06-11

### Added

- Added `dd_mm_yyyy_slash`, `dd_mm_yy_slash`, `dd_mm_yyyy_dash`, and `dd_mm_yy_dash` date formats to output_to_streams

## [0.10.16] - 2024-06-10

### Added

- Add `recommenders.report_url` (like `outcomes.report_url`) to provide signed download link for technical report

## [0.10.15] - 2024-05-28

### Added

- Added `conditions` option to datasets' output_to_streams, giving users the ability to filter which rows in the dataset should be added to the stream

## [0.10.14] - 2024-05-28

### Added

- Support UUID as a data type for detected columns in datasets

## [0.10.13] - 2024-05-21

### Added

- Add `PATCH /persona_sets/{persona_set_id}/personas/{persona_id}` to update a persona in a persona set. Supports name for now.

## [0.10.12] - 2024-05-13

### Added

- Added `privacy` option to datasets, giving users the ability to treat a dataset as a do not contact list (`suppress`) or as a `deletion` list (delete and do not contact)

## [0.10.11] - 2024-05-07

### Added

- datasets: reference_columns
- targets: reference: {dataset_id, column_name}

### Depreciated

- datasets: reference_key_column. Use datasets.reference_columns instead
- targets: reference_dataset_id. Use targets.reference.dataset_id instead

## [0.10.10] - 2024-05-06

### Added

- Added new identified target transformation option: address only

## [0.10.9] - 2024-04-30

### Added

- Add `predictors.blocked.providers` to outcomes resource. This will allow a user to block first party data from models during outcome builds.

## [0.10.8] - 2024-04-29

### Fixed

- add `date` as a `PrimiteDataType`
- reconcile `TraitCategory` with the actual categories used in the db

## [0.10.7] - 2024-04-12

### Added

- Added `output_all_columns_as_traits` as an alternative to `output_to_traits` when configuring datasets.

## [0.10.6] - 2024-03-21

### Added

- Add new dataset type `merge` - merges two or more existing datasets into a single dataset (leaves the original datasets intact)

## [0.10.5] - 2024-03-13

### Added

- Added `target_filter_recommender_ranks` and `target_filter_recommender_uncalibrated_probabilities` to the `filter` object of a `target`.

## [0.10.4] - 2024-02-14

### Added

- Added `schema` as an optional parameter for Microsoft SQL Server connection types.

## [0.10.3] - 2024-02-13

### Added

- Added `header_row` as an optional parameter for connection types that support CSV files.

## [0.10.2] - 2024-02-09

### Fixed

- Allow slashes in `detected_column` names

## [0.10.1] - 2024-02-08

### Added

- Add `recommender_ids` to `scope.payload`

## [0.10.0] - 2024-01-31

### Fixed

- Fixed DELETE status codes for all resources (except accounts because they have a waiting period) 202->204. This is technically a breaking change based on the _spec_ but the API was already returning 204.

## [0.9.3] - 2024-01-31

### Added

- Added include_geometry boolean to TargetModesAggregated to append optional geometries to aggregated targets.

## [0.9.2] - 2024-01-05

### Added

- Added dataset enrichment rates. This reports the number of identities that were appended with additional data, grouped by provider.

## [0.9.1] - 2023-12-05

### Added

- Add Recommenders endpoints for building and managing recommendation models.

## [0.9.1] - 2023-12-21

- Updated lift value descriptions for outcomes

## [0.9.0] - 2023-12-14

### Fixed

- Changed targets/{target_id}/lookup success response code from 201 to 200

## [0.8.2] - 2023-11-27

### Added

- Relaxed reference key pattern to allow for leading underscore.

## [0.8.1] - 2023-11-17

### Changed

- Outcome analysis descriptions for bias metrics updated.

## [0.8.0] - 2023-11-08

### Breaking

- Outcome analysis lift value is optional because not all reports have it yet.

## [0.7.15] - 2023-11-1

### Added

- Add customer id option to google ads connection

## [0.7.14] - 2023-10-30

### Fixed

- Require non-empty strings for resource names

## [0.7.13] - 2023-10-11

### Added

- Score explainability as an opt-in scope payload column

## [0.7.12] - 2023-10-10

### Changed

- Remove _target score_ language in favor of _target percentile_ for lift charts.

## [0.7.11] - 2023-09-06

### Added

- Add last_updated_config_at to most Resources
- Add last_read_input_at to most Resources

## [0.7.10] - 2023-08-24

### Added

- Add bias analysis to `GET /outcomes/{outcome_id}/analysis`

## [0.7.9] - 2023-08-17

### Added

- GET /traits/{trait_id}/analysis/dimensions - returns summary data about the trait. For example, what percentage of the US population falls into a certain age range.

## [0.7.8] - 2023-08-15

### Fixed

- Move maximum and minimum on target filter probability and percentile down onto the component/schema

## [0.7.7] - 2023-08-11

### Added

- Add bias mitigation to outcome configuration. Though the spec appears you can combine different mitigation strategies per dimension of concern (age=equity, gender=equality), API runtime validation will prevent it for now. Later we may support this so the spec is designed for future proofing. Note: age=none, gender=equity is allowed.

## [0.7.6] - 2023-08-07

### Deprecated

- Using Outcome Score in target filter is deprecated. Use Outcome percentile or probability instead.

## [0.7.5] - 2023-08-07

### Fixed

- Let BigQuery dataset names start with a number

## [0.7.4] - 2023-08-04

### Added

- Added dataset sample and non-null data (anonymized)

## [0.7.3] - 2023-08-03

### Added

- Add `lookup_api` connection type for targets
- Add JSON types for lookup requests

## [0.7.2] - 2023-07-31

### Added

- Added `GET outcomes/{outcome_id}/analysis` to return outcome report data for model performance, feature importance, and more.

## [0.7.1] - 2023-07-13

### Fixed

- connection options that aren't required now use `*` instead of `+` in regex pattern matching
- added `yyyymmdd` to data map formats

## [0.7.0] - 2023-06-22

### Breaking

- instead of billing via ppds (person-predictions per day), Faraday now bills via a variety of metrics (number of connections, number of known contacts, etc). The endpoint exposes this information to the users

## [0.6.0] - 2023-06-06

### Breaking

- Change shape of `datasets.output_to_traits` from string to object to support additional configuration details.
- Add metadata to the `/traits` endpoint including literate, description, units, and emitted_by_datasets.

## [0.5.3] - 2023-06-21

### Added

- Made some minor updates to managed connection types metadata.

## [0.5.2] - 2023-06-20

### Added

- Added new managed connection types.

## [0.5.1] - 2023-06-12

### Added

- Added a new target filter for score probabilities. Allows a user to filter a target with various operators by the following payload element `outcome_probability`.

## [0.5.0] - 2023-05-12

### Breaking

- `DELETE /account` no longer returns the account object - this is in-line with how the other `DELETE` endpoints work.

## [0.4.17] - 2023-05-11

### Added

- 'census_block_group', 'census_tract', and 'dma' are now options for geo aggregated targets.

## [0.4.16] - 2023-05-11

### Fixed

- Allow `false` to be passed to target filter persona and cohort membership `eq`

## [0.4.15] - 2023-04-25

### Added

- Target row_count limits now allow outcome_id to be optional.
- Added secondary connections (e.g. Klaviyo). These are marked as "managed" and therefore do NOT get written into the API spec.
- Added tags:string[] and blurb:string to ConnectionTypes. This is for the website only.

### Changed

- Added null (\_null) and not null (\_nnull) operators to target filters for outcome_percentile and outcome_score.

## [0.4.14] - 2023-04-10

### Added

- Added a new target tranformation called filter. Allows a user to filter a target with various operators by any of the following payload elements: persona_id, attributes (traits), cohort_membership, outcome_percentile, outcome_score.

## [0.4.13] - 2023-04-07

### Changed

- Example values for `explore` field in cohorts and `invert` in cohort place conditions so that users of the API docs get better default values.

## [0.4.12] - 2023-04-05

### Added

- GET uploads/{directory}/{filename} - download the file previously uploaded at POST uploads/{directory}/{filename}.

## [0.4.11] - 2023-03-22

### Added

- GET dependencies - returns the list of edges in a dependency graph of the account's resources.

## [0.4.10] - 2023-03-16

### Added

- Added 'managed' boolean to connections, datasets, and targets. Managed resources are read-only.

## [0.4.9] - 2023-02-24

### Added

- Added rules for liveramp as a target transformation.

## [0.4.8] - 2023-02-22

### Changed

- Updated connection type descriptions to match the new literates in vannevar.

## [0.4.7] - 2023-02-21

### Changed

- Cohort stream name is now mutable

## [0.4.6] - 2023-02-16

### Added

- Added new target transformation options for: pinterest, snapchat, klaviyo, segment, youtube, tiktok, taboola
- iterable, poplar, salesforce, google ads, facebook

## [0.4.5] - 2023-02-14

### Added

- New error: EXPIRED_API_KEY

## [0.4.4] - 2023-02-05

### Added

- data map format: static_date_iso8601, with column_name as the (temporary?) place you put the static value
- new date format yyyymm e.g. 201901

## [0.4.3] - 2023-01-28

### Added

- `freeform_address` and `email_hash` added to identity sets on data sets.

## [0.4.2] - 2023-01-24

### Added

- `number_of_clusters` parameter to PersonaSets

## [0.4.1] - 2023-01-12

### Added

- New `GET /cohorts/{cohort_id}/analysis/membership` endpoint to show cohort membership counts over time.

## [0.4.0] - 2023-01-12

### Breaking

- Change the format of event stream properties include type, statistical type, breaks, format, emitted_by_datasets.

## [0.3.23] - 2023-01-09

### Scopes

- added `columns` detailed metadata for the front-end.

### Targets

- added `human_readable`
- added `custom_structure` - see https://github.com/faradayio/fdy/blob/master/docs/TARGET_STRUCTURE_TRANSFORMATIONS.md
- deprecated `payload_map`

## [0.3.22] - 2023-01-06

### Added

- Implement DELETE for /traits

## [0.3.21] - 2023-01-03

### Added

- Remove TRIM on dateparsing and implement regex, removing time, only for when we do not autodetect

## [0.3.20] - 2022-12-21

### Added

- Places resource endpoint: GET, POST, PATCH, DELETE
- Added place_conditions parameter to /cohorts, used filter a Cohort's population using a Place's geometry

## [0.3.19] - 2022-12-20

### Added

- Targets: added linkedin transform preset

## [0.3.18] - 2022-12-13

### Changed

- Align the initial target transformation presets with the existing target update worker.

## [0.3.17] - 2022-12-09

### Changed

- /datasets upsert_column can now be PATCHed after the dataset is created

## [0.3.16] - 2022-12-07

### Added

- Target transformation presets and compilation script.

## [0.3.15] - 2022-12-06

### Added

- Add `GET /persona_sets/{persona_set_id}/analysis/flow` to return type persona analysis info on the associated value and member count of each persona by day.

## [0.3.14] - 2022-12-05

### Added

- Add `stream_conditions` field to cohorts. This allows users to specify values for stream properties to filter cohort membership.

## [0.3.13] - 2022-12-04

### Added

- Added person_full_name to datasets identity sets
- Allow spaces and capital letters in identity sets

## [0.3.12] - 2022-11-29

### Added

- PATCH and POST /outcomes - feature_blocklist could previously only include Faraday-provided traits. Now it can also include user-defined traits.

## [0.3.11] - 2022-11-29

### Added

- GET /streams and GET /streams/{id} endpoints now return properties. Properties are set on /datasets output_to_streams.

## [0.3.10] - 2022-11-22

### Added

- GET, POST, PATCH /datasets: for output_to_streams, instead of being limited to 'datetime', 'product', 'value', and 'channel', you can create any property.
- provided clearer date parsing specifications (yyyy_mm_dd_dash instead of date_iso8601, mm_dd_yy_slash instead of date_month_day_shortyear (this didn't even allow delimiter choosing)). For backwards compatibility, the old formats are still available, but depreciated.

## [0.3.9] - 2022-11-15

### Added

- Add `GET /persona_sets/{persona_set_id}/analysis/dimensions` to return typed persona analysis info for traits beyond the clustering/modeling_fields of the persona set. Eventually this can contain predictions and other event analysis information.

### Changed

- Marked `persona_set.personas[0].details.bins` as deprecated (use `/persona_sets/{persona_set_id}/analysis/dimensions` instead which has a typed response and contains more dimensions)

## [0.3.8] - 2022-11-15

### Changed

- support "upsert" for snowflake referenced targets

## [0.3.7] - 2022-11-11

### Added

- Added `_matches` field to trait conditions on cohorts for regex matching.

## [0.3.6] - 2022-11-02

### Added

- Added last_updated_output_at to most endpoints - this specifies when the resource last finished building.

## [0.3.5] - 2022-11-01

### Fixed

- Make `persona.id` required (non-nullable).

## [0.3.4] - 2022-10-28

### Added

- Added GET /accounts - to show your account plus all subaccounts
- Added GET /accounts/{id} - to show the details of a specific account
- Added GET /accounts/current - to show the details of the account associated with your specific API key
- Added GET /accounds/{id}/billing - to show billing details for the given account. including payments, invoices, and account usage

## [0.3.3] - 2022-10-28

### Added

- New field `persona.individuals_count` returns number of members that match the persona within the cohort the set was based on.

## [0.3.2] - 2022-10-24

### Added

- Allow spaces in column names

## [0.3.1] - 2022-10-24

### Added

- Added "case_sensitive_columns" to Snowflake datasets

## [0.3.0] - 2022-10-17

### Added

- Added `name` and `explore` fields to creating persona sets
- Added `PATCH` support for `/persona_sets/{persona_set_id}` to update `name` and `explore`

### Breaking

- `name` is now required for `POST /persona_sets`

## [0.2.11] - 2022-10-14

### Added

- DELETE endpoints for all resources except traits.

## [0.2.10] - 2022-10-13

### Added

- add matched_count to /datasets. This will show the user how many of their identified people matched a person in Faraday's data.
- fixed the calculation for row count and identified count.

## [0.2.9] - 2022-10-13

### Changed

- allow space character in SQL server `database` options

### Added

- support "upsert" for bigquery referenced targets

## [0.2.8] - 2022-10-05

### Added

- new supported 'format' for /datasets output_to_streams - seconds since unix epoch and milliseconds since epoch

## [0.2.7] - 2022-10-03

### Changed

- show whether cohort is classic (managed)

## [0.2.6] - 2022-09-29

### Changed

- allow bucket prefixes to start with capital letters and numbers

## [0.2.5] - 2022-09-21

### Changed

- allow colon in column names (e.g. "Source: Product Description")

### Changed

## [0.2.4] - 2022-09-10

### Changed

- added dataset updates, showing the date and rows added per update. Note that we don't currently provide the row count pre-processing as this is technically difficult.

## [0.2.3] - 2022-09-06

### Changed

- refactor target limits to support two types of input: percentile ranges (WHERE min <= percentile_score <= max) and absolute limits (LIMIT)

## [0.2.2] - 2022-09-06

### Changed

- add `explore` boolean to cohorts

## [0.2.1] - 2022-09-02

### Changed

- add `preview` mode to datasets, facilitating "New Dataset" UI (and advanced API users who want low latency column detection)
- allow spaces in column names (e.g. "Product Description")

## [0.2.0] - 2022-08-30

### Changed

- move required `dataset_name` from BigQuery datasets/targets to BigQuery connection level

## [0.1.19] - 2022-08-25

- add `active` to `persona_sets`

## [0.1.18] - 2022-08-21

- add `contents` and `contents_error` to connections

## [0.1.17] - 2022-08-18

### Changed

- add `metro` as an aggregation option to targets

## [0.1.16] - 2022-08-17

### Changed

- for /datasets endpoints, made `output_to_streams` optional

## [0.1.15] - 2022-08-15

### Added

- `/datasets` read-only, optional fields `row_count` and `identified_count`

## [0.1.14] - 2022-08-09

### Changed

- Create a new 403 error code MAX_RESOURCES_REACHED. When user hits the resource quota, they will get a 403 MAX_RESOURCES_REACHED error instead of 403 FORBIDDEN. The user will instead get FORBIDDEN if they do not have access to the resource.

## [0.1.13] - 2022-08-04

### Changed

- `/targets` endpoint re-spec
- Added support for read-only connection_types_options

## [0.1.12] - 2022-07-29

### Added

- `GET /datasets[/X]` now returns `name`

## [0.1.11] - 2022-07-28

### Added

- `GET /datasets[/X]` now returns `detected_columns`

## [0.1.10] - 2022-07-27

### Added

- `GET /scopes/{scope_id}/datasets` for returning all datasets associated with a scope's population cohorts.

## [0.1.9] - 2022-07-26

### Added

- `fig/geography` trait category to distinguish location-based fields which contain census, ZIP, etc ID's.

## [0.1.8] - 2022-07-19

### Added

- `report_url` to scopes for returning a signed url with the report location
- `output_url` to targets for returning a signed url for the default output

## [0.1.7] - 2022-07-18

### Added

- New to datasets: `primary_key_column`.

## [0.1.6] - 2022-07-12

### Added

- `GET /scope/{scope_id}/payload/cohorts` for returning all cohorts in the scope's payload

## [0.1.5] - 2022-07-11

### Fixed

- Scope payload attributes will not fail validation for prefixed field names.

## [0.1.4] - 2022-07-07

### Fixed

- `url` for snowlake connections now uses the correct regex.

## [0.1.3] - 2022-06-27

### Added

- `connections/{connection_id}/targets` endpoint, which returns all targets with the given connection_id

### Fixed

- `url` for redshift connections now uses the correct regex.

## [0.1.2] - 2022-06-24

### Added

- Recency options to the /cohorts endpoint.

## [0.1.1] - 2022-06-23

### Added

- Added `classic` options for datasets and connections to expose querying and patching of classic datasets.

## [0.1.0] - 2022-06-23

### Fixed

- Obsolete code in this repository has been deleted.
- This repository is now completely standalone.

## [0.2.0] - 2022-06-26

### Changed

- Name is now reqired on cohorts.