Retrieve all targets that use this connection

gethttps://api.faraday.ai/v1/connections/{connection_id}/targets

Get all targets that use this connection

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

connection_idstring<uuid>required

The UUID of a connection

Example: "5e0dfa56-2d52-4c06-a870-bc79c71e86a3"

Responses

200The list of targets

Items of array[object]

analysis_configobject

Configuration for the analysis of the target.

Properties of object

geographiesarray[string]

Configuration for the analysis of geographic dimensions

traitsarray[string]

Configuration for the analysis of traits. For traits created through output_to_traits via /datasets, specify the trait name. For traits from Faraday's Internal Graph (FIG), specify the name prefixed by fig/ ex. fig/age.

archived_atstring<date-time>

If not null, this resource will no longer receive updates, but will still be visable.

connection_idstring<uuid>

If this is a replication (externally-hosted) target, the UUID of a connection - see /connections for more detail.

If this is not a replication target, omit this parameter.

Example: "5e0dfa56-2d52-4c06-a870-bc79c71e86a3"

countinteger

The number of records in the target. This is only included in the response if the target is built.

created_atstring<date-time>required

When this resource was created.

custom_structurearray[object]

By default, targets include all columns in the target preview, with no name changes.

Users may use this parameter to specify ...

Items of array[object]

aggregationstring

The method of aggregation. Applies to aggregation targets only.

Allowed values: avg, count, countif, mode, ignore

aggregation_criteriastring

For scope columns that can be aggregated with countif (currently just persona sets), this is the value being counted (i.e. the persona ID). Applies to aggregation targets only.

is_identity_colboolean

Set this to true when exporting first party identifiers (given by identity_sets).

If true, scope_col represents the dataset field name being selected (ex: "client_email").

output_colstringrequired

The name of this column in the target export. Can be the same as scope_col.

Match pattern: ^[_a-z][_a-z0-9]*$

scope_colstringrequired

The name of the scope column to export.

Users can supply either the machine-readable name (with underscored uuid) or the human-readable name (with literates).

Match pattern: ^[_a-z][_a-z0-9]*$

filterobject

Filter the rows exported in a target using the scope payload elements.

Deprecated: To filter by outcome scores, use outcome_score.
To filter by outcome probability, use outcome_probability...

Properties of object

cohort_membershiparray[object]

List of conditions to filter cohort membership on.

Items of array[object]

_eqbooleanrequired

Equal to

cohort_idstring<uuid>required

Cohort id to filter on.

Example: "b80217ae-7628-4c66-8a19-5bf452495c39"

outcome_percentilearray[object]

List of conditions to filter outcome percentile on.

Items of array[object]

_eqnumber

Equal to

_gtnumber

Greater than

_gtenumber

Greater than or equal to

_ltnumber

Less than

_ltenumber

Less than or equal to

_nnullboolean

Value is not null

_nullboolean

Value is null

outcome_idstring<uuid>required

Outcome id to filter on.

Example: "b80217ae-7628-4c66-8a19-5bf452495c39"

outcome_probabilityarray[object]

List of conditions to filter outcome probability on.

Items of array[object]

_eqnumber<float>

Equal to

_gtnumber<float>

Greater than

_gtenumber<float>

Greater than or equal to

_ltnumber<float>

Less than

_ltenumber<float>

Less than or equal to

_nnullboolean

Value is not null

_nullboolean

Value is null

outcome_idstring<uuid>required

Outcome id to filter on.

Example: "b80217ae-7628-4c66-8a19-5bf452495c39"

outcome_scorearray[object]

Deprecated: List of conditions to filter outcome score on.

Items of array[object]

_eqnumber

Equal to

_gtnumber

Greater than

_gtenumber

Greater than or equal to

_ltnumber

Less than

_ltenumber

Less than or equal to

_nnullboolean

Value is not null

_nullboolean

Value is null

outcome_idstring<uuid>required

Outcome id to filter on.

Example: "b80217ae-7628-4c66-8a19-5bf452495c39"

personaarray[object]

List of conditions to filter persona set personid on.

Items of array[object]

_eqbooleanrequired

Equal to

persona_idstring<uuid>required

Individual persona id to filter on.

Example: "7a19cdb4-cf4b-4cbd-95ec-aa60b8fda90b"

persona_set_idstring<uuid>required

Persona set id to filter on.

Example: "b80217ae-7628-4c66-8a19-5bf452495c39"

recommender_rankarray[object]

List of conditions to filter recommender rank on.

Items of array[object]

_eqnumber

Equal to

_gtnumber

Greater than

_gtenumber

Greater than or equal to

_ltnumber

Less than

_ltenumber

Less than or equal to

_nnullboolean

Value is not null

_nullboolean

Value is null

recommender_idstring<uuid>required

Recommender id to filter on.

Example: "b80217ae-7628-4c66-8a19-5bf452495c39"

recommender_uncalibrated_probabilityarray[object]

List of conditions to filter recommender uncalibrated probability on.

Items of array[object]

_eqnumber<float>

Equal to

_gtnumber<float>

Greater than

_gtenumber<float>

Greater than or equal to

_ltnumber<float>

Less than

_ltenumber<float>

Less than or equal to

_nnullboolean

Value is not null

_nullboolean

Value is null

recommender_idstring<uuid>required

Recommender id to filter on.

Example: "b80217ae-7628-4c66-8a19-5bf452495c39"

traitarray[object]

List of conditions to filter traits.

Items of array[object]

_eqstring

Equal to

_gtnumber

Greater than

_gtenumber

Greater than or equal to

_inarray[string]

Value is one of

_ltnumber

Less than

_ltenumber

Less than or equal to

_matchesstring

Value contains a match to the regex (re2) expression provided. For an exact regex match, use the ^ and $ characters as specified by the (re2 documentation)[https://github.com/google/re2/wiki/Syntax].

_neqstring

Not equal to

_ninarray[string]

Value is not one of

_nnullboolean

Value is not null

_nullboolean

Value is null (nulls are otherwise excluded)

namestringrequired

The name of the trait.

final_structurearray[object]

Final structure of the target export. This is only included in the response if the target is built.

Items of array[object]

aggregationstring

The method of aggregation. Applies to aggregation targets only.

Allowed values: avg, count, countif, mode, ignore

aggregation_criteriastring

For scope columns that can be aggregated with countif (currently just persona sets), this is the value being counted (i.e. the persona ID). Applies to aggregation targets only.

is_identity_colboolean

Set this to true when exporting first party identifiers (given by identity_sets).

If true, scope_col represents the dataset field name being selected (ex: "client_email").

output_colstringrequired

The name of this column in the target export. Can be the same as scope_col.

Match pattern: ^[_a-z][_a-z0-9]*$

scope_colstringrequired

The name of the scope column to export.

Users can supply either the machine-readable name (with underscored uuid) or the human-readable name (with literates).

Match pattern: ^[_a-z][_a-z0-9]*$

human_readableboolean

By default, column names are exported in a machine-readable format with underscored uuids.

Setting this to true replaces ids with literates in the exported column names.

idstring<uuid>required

A unique ID for this resource.

Example: "ba647bc4-55f1-49f9-b0da-fccff5b51bfe"

last_read_input_atstring<date-time>

The last time this resource's input was read.

last_updated_config_atstring<date-time>

The last time this resource's configuration was updated. If this is more recent than last_updated_output_at, the resource will be rebuilt.

last_updated_output_atstring<date-time>

The last time this resource successfully built.

limitdiscriminated type (method)

Restrict the number of rows exported in a target.

To apply an absolute row limit, use row_count.
Deprecated: To filter by percentile scores, use percentile (use filter outcome_percentile...

Properties of discriminated type (method)

method

method#stringrequireddiscriminator

Value: "row_count"

directionstring

When an outcome_id is given, this parameter sets the sort direction: for the "top" scores, specify descending. For the "bottom" scores, specify ascending.

If not specified, defaults to descending.

Allowed values: ascending, descending

outcome_idstring<uuid>

Use the ranking suggested by the outcome's scores.

Example: "b80217ae-7628-4c66-8a19-5bf452495c39"

thresholdintegerrequired

Specify a whole number to restrict the target to a specific number of records.

Example: 1000

managedboolean

A managed target requires special configuration from a Faraday admin, and is read-only.

Example: true

namestringrequired

A user-friendly name of the target.

Match pattern: ^(?!\s*$).+

optionsdiscriminated type (type)required

The export target configuration options. These vary by connection type.

Properties of discriminated type (type)

type

type#stringrequireddiscriminator

Value: "aws_aurora_mysql"

table_namestringrequired

Table name

Match pattern: ^[_a-zA-Z][a-zA-Z0-9_]+$

payload_mapdictionary[string, string]

Deprecated: use custom_structure.

By default, targets include all columns in the target preview, with no name changes.
...

representationdiscriminated type (mode)required

Choose how the scopes's output should be formatted for this target. The following modes are available:

aggregated

This option will produce one row per geographical area.
This option...

Properties of discriminated type (mode)

mode

mode#stringrequireddiscriminator

Value: "hashed"

transform_presetstring

One of:

default: Faraday default hashed representation
linkedin: Hashed upload format for Linkedin
taboola: Hashed upload format for Taboola
snapchat: Hashed upload format for Snapchat...

Allowed values: default, linkedin, taboola, snapchat, tiktok, pinterest, youtube, google_ads, facebook

resource_typestringrequired

The type of this resource.

Example: "targets"

scope_idstring<uuid>required

The UUID of a scope - see /scopes for more detail.

Example: "8e63467d-9478-4fba-b05a-d5e98fd06d12"

statusstringrequired

The current state of this resource and any updates.

Example: "pending"

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

status_changed_atstring<date-time>

When the status of this resource was last updated.

status_errorstring

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

updated_atstring<date-time>required

When this resource was last updated.

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

connections

Test request

Request snippet

curl -X GET 'https://api.faraday.ai/v1/connections/{connection_id}/targets' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

application/json

[
  {
    "analysis_config": {
      "geographies": [
        "postcode"
      ],
      "traits": [
        "fig/age"
      ]
    },
    "archived_at": "2024-01-01T12:00:00Z",
    "connection_id": "5e0dfa56-2d52-4c06-a870-bc79c71e86a3",
    "count": 0,
    "created_at": "2024-01-01T12:00:00Z",
    "custom_structure": [
      {
        "aggregation": "avg",
        "aggregation_criteria": "string",
        "is_identity_col": true,
        "output_col": "string (pattern: ^[_a-z][_a-z0-9]*$)",
        "scope_col": "string (pattern: ^[_a-z][_a-z0-9]*$)"
      }
    ],
    "filter": {
      "cohort_membership": [
        {
          "_eq": true,
          "cohort_id": "b80217ae-7628-4c66-8a19-5bf452495c39"
        }
      ],
      "outcome_percentile": [
        {
          "_eq": 1,
          "_gt": 1,
          "_gte": 1,
          "_lt": 1,
          "_lte": 1,
          "_nnull": true,
          "_null": true,
          "outcome_id": "b80217ae-7628-4c66-8a19-5bf452495c39"
        }
      ],
      "outcome_probability": [
        {
          "_eq": 0,
          "_gt": 0,
          "_gte": 0,
          "_lt": 0,
          "_lte": 0,
          "_nnull": true,
          "_null": true,
          "outcome_id": "b80217ae-7628-4c66-8a19-5bf452495c39"
        }
      ],
      "outcome_score": [
        {
          "_eq": 0,
          "_gt": 0,
          "_gte": 0,
          "_lt": 0,
          "_lte": 0,
          "_nnull": true,
          "_null": true,
          "outcome_id": "b80217ae-7628-4c66-8a19-5bf452495c39"
        }
      ],
      "persona": [
        {
          "_eq": true,
          "persona_id": "7a19cdb4-cf4b-4cbd-95ec-aa60b8fda90b",
          "persona_set_id": "b80217ae-7628-4c66-8a19-5bf452495c39"
        }
      ],
      "recommender_rank": [
        {
          "_eq": 1,
          "_gt": 1,
          "_gte": 1,
          "_lt": 1,
          "_lte": 1,
          "_nnull": true,
          "_null": true,
          "recommender_id": "b80217ae-7628-4c66-8a19-5bf452495c39"
        }
      ],
      "recommender_uncalibrated_probability": [
        {
          "_eq": 0,
          "_gt": 0,
          "_gte": 0,
          "_lt": 0,
          "_lte": 0,
          "_nnull": true,
          "_null": true,
          "recommender_id": "b80217ae-7628-4c66-8a19-5bf452495c39"
        }
      ],
      "trait": [
        {
          "_eq": "string",
          "_gt": 0,
          "_gte": 0,
          "_in": [
            "string"
          ],
          "_lt": 0,
          "_lte": 0,
          "_matches": "string",
          "_neq": "string",
          "_nin": [
            "string"
          ],
          "_nnull": true,
          "_null": true,
          "name": "string"
        }
      ]
    },
    "final_structure": [
      {
        "aggregation": "avg",
        "aggregation_criteria": "string",
        "is_identity_col": true,
        "output_col": "string (pattern: ^[_a-z][_a-z0-9]*$)",
        "scope_col": "string (pattern: ^[_a-z][_a-z0-9]*$)"
      }
    ],
    "human_readable": true,
    "id": "ba647bc4-55f1-49f9-b0da-fccff5b51bfe",
    "last_read_input_at": "2024-01-01T12:00:00Z",
    "last_updated_config_at": "2024-01-01T12:00:00Z",
    "last_updated_output_at": "2024-01-01T12:00:00Z",
    "limit": {
      "direction": "ascending",
      "method": "row_count",
      "outcome_id": "b80217ae-7628-4c66-8a19-5bf452495c39",
      "threshold": 1000
    },
    "managed": true,
    "name": "string (pattern: ^(?!\\s*$).+)",
    "options": {
      "table_name": "string (pattern: ^[_a-zA-Z][a-zA-Z0-9_]+$)",
      "type": "aws_aurora_mysql"
    },
    "payload_map": {
      "key": "string"
    },
    "representation": {
      "mode": "hashed",
      "transform_preset": "default"
    },
    "resource_type": "targets",
    "scope_id": "8e63467d-9478-4fba-b05a-d5e98fd06d12",
    "status": "pending",
    "status_changed_at": "2024-01-01T12:00:00Z",
    "status_error": "string",
    "updated_at": "2024-01-01T12:00:00Z"
  }
]