Faraday REST API

A market opportunity analysis report allows you to measure penetration and opportunity in your market. With this report, you can see the size and location of remaining opportunity in your market, which can help you focus your efforts accordingly.Show all...

array of:

archived_at

string<date-time>

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

created_at

string<date-time>

required

When this resource was created.

google_sheets_url

string<uri>

URL to the Google Sheets spreadsheet of the market opportunity analysis. Available once the market opportunity analysis has been run. Permission to view the spreadsheet is granted to all users on the current account.

google_slides_url

string<uri>

URL to the Google Slides presentation of the market opportunity analysis. Available once the market opportunity analysis has been run. Permission to view the presentation is granted to all users on the current account.

string<uuid>

required

A unique ID for this resource.

last_read_input_at

string<date-time>

The last time this resource's input was read.

last_updated_config_at

string<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_at

string<date-time>

The last time this resource successfully built.

name

string

required

Human-readable label for this market opportunity analysis

<= 64 characters

Match pattern:

^(?!\s*$).+

outcome_id

string<uuid>

required

Outcome must be in the scope payload.

overall_report

object

Summary over the latest report. Available once the market opportunity analysis has been run.

adjusted_in_population_attainers

integer

required

average_total_value_per_in_population_attainer

integer

required

average_value_per_in_population_attainment

integer

required

in_population_remaining_attainment_value

integer

required

in_population_remaining_likely_attainers

integer

required

total_value_of_adjusted_in_population_attainment

integer

required

persona_id

string<uuid>

persona_id must belong to the persona_set_id chosen. Providing a persona_id will do further analysis on the persona, but is not required to generate results for the persona set as a whole.

persona_set_id

string<uuid>

Optionally select a persona set to analyze. Persona set must be in the scope payload.

resource_type

string

required

The type of this resource.

scope_id

string<uuid>

required

status

string

required

The current state of this resource and any updates.

Allowed values:

newstartingrunningreadyerror

Example:

pending

status_changed_at

string<date-time>

When the status of this resource was last updated.

status_error

string

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

updated_at

string<date-time>

required

When this resource was last updated.

Auth

curl --request GET \
  --url https://api.faraday.ai/v1/market_opportunity_analyses \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'

Response Example

1
[
2
  {
3
    "archived_at": "2019-08-24T14:15:22Z",
4
    "created_at": "2019-08-24T14:15:22Z",
5
    "google_sheets_url": "http://example.com",
6
    "google_slides_url": "http://example.com",
7
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
8
    "last_read_input_at": "2019-08-24T14:15:22Z",
9
    "last_updated_config_at": "2019-08-24T14:15:22Z",
10
    "last_updated_output_at": "2019-08-24T14:15:22Z",
11
    "name": "string",
12
    "outcome_id": "0323e489-6bf9-4b68-9c8d-5674f46921e4",
13
    "overall_report": {
14
      "adjusted_in_population_attainers": 0,
15
      "average_total_value_per_in_population_attainer": 0,
16
      "average_value_per_in_population_attainment": 0,
17
      "in_population_remaining_attainment_value": 0,
18
      "in_population_remaining_likely_attainers": 0,
19
      "total_value_of_adjusted_in_population_attainment": 0
20
    },
21
    "persona_id": "84321d19-6cb7-45af-a8d3-0bb38b11a872",
22
    "persona_set_id": "15f06c33-16a6-41b2-9bf5-5bf0b2fc1b13",
23
    "resource_type": "string",
24
    "scope_id": "5d3fe357-12dd-4f62-b004-6d1fb3b8454f",
25
    "status": "pending",
26
    "status_changed_at": "2019-08-24T14:15:22Z",
27
    "status_error": "string",
28
    "updated_at": "2019-08-24T14:15:22Z"
29
  }
30
]

Faraday REST API

Get all market opportunity analyses

Request

Responses

Body