Get a configuration audit of the current account

gethttps://api.faraday.ai/v1/accounts/current/audits/{audit_id}

One configuration audit, in full.

Authentication

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

path parameters

audit_idstring<uuid>required

The UUID of an audit

Responses

200The audit.
applied_atstring<date-time>

When every appliable change had been carried out. Absent otherwise.

apply_errorstring

Why the apply did not finish. Present only when apply_status is error.

apply_statusstring

The outcome of applying this audit. Absent until an apply is
requested; running while it is under way, applied when every
appliable change was carried out, error when one failed or the
apply was refused (see apply_error).

Allowed values: running, applied, error
changesarray[object]

What would bring the account in line with its use cases: resources
to create, and resources whose configuration differs from what the
use cases require. Empty when the account is aligned. Omitted from...

Items of array[object]
actionstringrequired

Create a missing resource, or update one whose configuration differs.

Allowed values: create, update
appliablebooleanrequired

False when this change cannot be made by applying the audit and is
reported for a person to make: it sets a credential, or it could
only be made by replacing the resource.

applied_atstring<date-time>

When this change was carried out. Absent if it was not.

apply_errorstring

Why this change could not be carried out. Absent if it was not attempted or succeeded.

detailstring

A plain-text description of the change.

differing_attributesarray[string]required

For an update, the attributes whose values differ. A credential
appears with the suffix (redacted), since its value is never
read.

idstring<uuid>required
resource_idstring<uuid>

The resource to update. Absent when action is create.

resource_namestringrequired
resource_typestringrequired

The type of a resource which is available via the REST SDK.

Example: "scopes"
Allowed values: accounts, atlases, attributes, cohorts, connections, datasets, feature_stores, market_opportunity_analyses, migrations, outcomes, persona_sets, places, recommenders, scopes, streams, targets, traits
use_case_idsarray[string]required

The use cases that ask for this change.

conflictsarray[object]required

Resources that more than one use case wants configured differently.
The audit compares against the first use case's version, so the
others are not fully represented. These are for the knowledgebase's
...

Items of array[object]
resource_idstring<uuid>

The resource, when the account already has it.

resource_namestringrequired
resource_typestringrequired

The type of a resource which is available via the REST SDK.

Example: "scopes"
Allowed values: accounts, atlases, attributes, cohorts, connections, datasets, feature_stores, market_opportunity_analyses, migrations, outcomes, persona_sets, places, recommenders, scopes, streams, targets, traits
use_case_idsarray[string]required

Every use case that wants this resource. The first is the version
the audit compared against.

created_atstring<date-time>required
idstring<uuid>required
not_applicable_reasonstring

Present when the audit finished and concluded that the account
cannot be audited, because nothing establishes that its use cases
describe what should exist in this account: it has no knowledgebase,
it...

orphaned_resourcesarray[object]

Resources no use case asks for. Advisory: applying the audit never
archives them. Omitted from listings and from audits that are not
applicable.

Items of array[object]
notestring

A plain-text note about the resource.

resource_idstring<uuid>required
resource_typestringrequired

The type of a resource which is available via the REST SDK.

Example: "scopes"
Allowed values: accounts, atlases, attributes, cohorts, connections, datasets, feature_stores, market_opportunity_analyses, migrations, outcomes, persona_sets, places, recommenders, scopes, streams, targets, traits
statusstringrequired

running while the audit reads the account, ready once it has
finished, error if it could not finish (see status_error).

Allowed values: running, ready, error
status_errorstring

Why the audit could not finish. Present only when status is error.

updated_atstring<date-time>required
use_casesarray[object]

Each use case the audit compared against, and whether the account
serves it. Omitted from listings and from audits that are not
applicable.

Items of array[object]
correctbooleanrequired

True when the account's configuration serves this use case: nothing
to change on its behalf, and no unmet prerequisite.

resourcesarray[object]required

The account's resources that the audit found serving this use case.
Resources the use case needs but the account does not have are not
listed; their create changes say they are needed.

Items of array[object]
resource_idstring<uuid>required
resource_typestringrequired

The type of a resource which is available via the REST SDK.

Example: "scopes"
Allowed values: accounts, atlases, attributes, cohorts, connections, datasets, feature_stores, market_opportunity_analyses, migrations, outcomes, persona_sets, places, recommenders, scopes, streams, targets, traits
unmet_prerequisitesarray[string]required

Things the use case needs that configuration cannot provide.

use_case_idstring<uuid>required
use_case_revision_idstring<uuid>required

The revision of the use case that was audited.

400The request was invalid.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

401No API key was supplied.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

403Access to this resource was forbidden.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

404The requested resource ID was not found.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

500An internal server error occurred.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

Tags

accounts