Retrieve a dependency graph for all resources on an account

gethttps://api.faraday.ai/v1/graph

Each object in the list is an edge in the dependency graph.

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

Responses

200The list of graph edges
Items of array[object]
downstream_archived_atstring<date-time>
downstream_idstring<uuid>required

the id of the resource that depends on the upstream resource

Example: "24f830ff-2769-4c1f-989b-0a87481a1025"

When the downstream resource's latest finished build started reading its configuration and inputs. Once this is at or after downstream_last_updated_config_at, a build with its current configuration ...

When Faraday registered the latest change to the downstream resource's configuration, or the latest force_update. The downstream resource builds again whenever this is later than downstream_last_read_input_at.

When a build last changed the downstream resource's output. A build that finishes with nothing new to write does not move it.

downstream_literatestringrequired

A more human-consumable version of the name of the downstream resource.

Example: "customer personas"
downstream_statusstringrequired

The current state of this resource and any updates.

Example: "ready"
Allowed values: new, starting, running, ready, error

When the status of this resource was last updated.

If this resource has status == "error", this will contain an error message.

What Faraday is waiting for before it builds this resource again when status == "error". See status_needs_fix_from on the resource.

Allowed values: user, support
downstream_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, forecasts, insights, market_opportunity_analyses, migrations, outcomes, persona_sets, places, recommenders, scopes, streams, targets, traits
upstream_archived_atstring<date-time>
upstream_idstring<uuid>required

the id of the resource that is depended on by the downstream resource

Example: "2c1881c4-a0c0-424d-89e1-b481f3cb118c"

When the upstream resource's latest finished build started reading its configuration and inputs. Once this is at or after upstream_last_updated_config_at, a build with the upstream resource's current configuration has finished.

When Faraday registered the latest change to the upstream resource's configuration, or the latest force_update. The upstream resource builds again whenever this is later than upstream_last_read_input_at.

When a build last changed the upstream resource's output. The downstream resource builds again when this is later than its last_read_input_at.

upstream_literatestringrequired

A more human-consumable version of the name of the upstream resource.

Example: "customers"
upstream_statusstringrequired

The current state of this resource and any updates.

Example: "ready"
Allowed values: new, starting, running, ready, error

When the status of this resource was last updated.

If this resource has status == "error", this will contain an error message.

What Faraday is waiting for before it builds this resource again when status == "error". See status_needs_fix_from on the resource.

Allowed values: user, support
upstream_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, forecasts, insights, market_opportunity_analyses, migrations, outcomes, persona_sets, places, recommenders, scopes, streams, targets, traits
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, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
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.

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, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
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.

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, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
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.

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, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
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.

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, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
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.

A suggestion for fixing this error.

Tags

graph