From 03889b6b5e5dadb24a2173c8f5ce40b54a616b77 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Fri, 10 Nov 2023 11:36:13 +0100 Subject: [PATCH] update streams --- .../frontapp/v1/accounts_table.md | 115 ++++++++++++++++++ .../frontapp/v1/channels_table.md | 113 +++++++++++++++++ .../frontapp/v1/inboxes_table.md | 113 +++++++++++++++++ .../frontapp/v1/tags_table.md | 108 +++++++++++----- .../frontapp/v1/team_table.md | 114 ----------------- .../frontapp/v1/teammates_table.md | 113 +++++++++++++++++ .../frontapp/v1/teams_table.md | 113 +++++++++++++++++ 7 files changed, 644 insertions(+), 145 deletions(-) create mode 100644 _integration-schemas/frontapp/v1/accounts_table.md create mode 100644 _integration-schemas/frontapp/v1/channels_table.md create mode 100644 _integration-schemas/frontapp/v1/inboxes_table.md delete mode 100644 _integration-schemas/frontapp/v1/team_table.md create mode 100644 _integration-schemas/frontapp/v1/teammates_table.md create mode 100644 _integration-schemas/frontapp/v1/teams_table.md diff --git a/_integration-schemas/frontapp/v1/accounts_table.md b/_integration-schemas/frontapp/v1/accounts_table.md new file mode 100644 index 000000000..fe869ccaf --- /dev/null +++ b/_integration-schemas/frontapp/v1/accounts_table.md @@ -0,0 +1,115 @@ +--- +tap: "frontapp" +version: "V1" +key: "" + +name: "accounts_table" +doc-link: +singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/accounts_table.json +description: "" + +replication-method: "Key-based Incremental" + +table-key-properties: "report_id" +valid-replication-keys: "analytics_date","analytics_range" + +attributes: + - name: "analytics_date" + type: "string" + description: "" + replication-key: true + + - name: "analytics_range" + type: "string" + description: "" + replication-key: true + + - name: "avg_first_response_time" + type: "number" + description: "" + + - name: "avg_handle_time" + type: "number" + description: "" + + - name: "avg_response_time" + type: "number" + description: "" + + - name: "avg_sla_breach_time" + type: "number" + description: "" + + - name: "avg_total_reply_time" + type: "number" + description: "" + + - name: "metric_description" + type: "string" + description: "" + + - name: "metric_id" + type: "string" + description: "" + + - name: "new_segments_count" + type: "number" + description: "" + + - name: "num_active_segments_full" + type: "number" + description: "" + + - name: "num_archived_segments" + type: "number" + description: "" + + - name: "num_archived_segments_with_reply" + type: "number" + description: "" + + - name: "num_closed_segments" + type: "number" + description: "" + + - name: "num_csat_survey_response" + type: "number" + description: "" + + - name: "num_messages_received" + type: "number" + description: "" + + - name: "num_messages_sent" + type: "number" + description: "" + + - name: "num_open_segments_end" + type: "number" + description: "" + + - name: "num_open_segments_start" + type: "number" + description: "" + + - name: "num_sla_breach" + type: "number" + description: "" + + - name: "num_workload_segments" + type: "number" + description: "" + + - name: "pct_csat_survey_satisfaction" + type: "number" + description: "" + + - name: "pct_tagged_conversations" + type: "number" + description: "" + + - name: "report_id" + type: "string" + description: "" + primary-key: true +--- \ No newline at end of file diff --git a/_integration-schemas/frontapp/v1/channels_table.md b/_integration-schemas/frontapp/v1/channels_table.md new file mode 100644 index 000000000..ff0254f56 --- /dev/null +++ b/_integration-schemas/frontapp/v1/channels_table.md @@ -0,0 +1,113 @@ +--- +tap: "frontapp" +version: "V1" +key: "" + +name: "channels_table" +doc-link: +singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/channels_table.json +description: "" + +replication-method: "Key-based Incremental" + +table-key-properties: "report_id" +valid-replication-keys: "analytics_date", "analytics_range" + +attributes: + - name: "analytics_date" + type: "string" + description: "" + replication-key: true + - name: "analytics_range" + type: "string" + description: "" + replication-key: true + - name: "avg_first_response_time" + type: "number" + description: "" + + - name: "avg_handle_time" + type: "number" + description: "" + + - name: "avg_response_time" + type: "number" + description: "" + + - name: "avg_sla_breach_time" + type: "number" + description: "" + + - name: "avg_total_reply_time" + type: "number" + description: "" + + - name: "metric_description" + type: "string" + description: "" + + - name: "metric_id" + type: "string" + description: "" + + - name: "new_segments_count" + type: "number" + description: "" + + - name: "num_active_segments_full" + type: "number" + description: "" + + - name: "num_archived_segments" + type: "number" + description: "" + + - name: "num_archived_segments_with_reply" + type: "number" + description: "" + + - name: "num_closed_segments" + type: "number" + description: "" + + - name: "num_csat_survey_response" + type: "number" + description: "" + + - name: "num_messages_received" + type: "number" + description: "" + + - name: "num_messages_sent" + type: "number" + description: "" + + - name: "num_open_segments_end" + type: "number" + description: "" + + - name: "num_open_segments_start" + type: "number" + description: "" + + - name: "num_sla_breach" + type: "number" + description: "" + + - name: "num_workload_segments" + type: "number" + description: "" + + - name: "pct_csat_survey_satisfaction" + type: "number" + description: "" + + - name: "pct_tagged_conversations" + type: "number" + description: "" + + - name: "report_id" + type: "string" + description: "" + primary-key: true + diff --git a/_integration-schemas/frontapp/v1/inboxes_table.md b/_integration-schemas/frontapp/v1/inboxes_table.md new file mode 100644 index 000000000..b85017667 --- /dev/null +++ b/_integration-schemas/frontapp/v1/inboxes_table.md @@ -0,0 +1,113 @@ +--- +tap: "frontapp" +version: "V1" +key: "" + +name: "inboxes_table" +doc-link: +singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/inboxes_table.json +description: "" + +replication-method: "Key-based Incremental" + +table-key-properties: "report_id" +valid-replication-keys: "analytics_date", "analytics_range" + +attributes: + - name: "analytics_date" + type: "string" + description: "" + replication-key: true + - name: "analytics_range" + type: "string" + description: "" + replication-key: true + - name: "avg_first_response_time" + type: "number" + description: "" + + - name: "avg_handle_time" + type: "number" + description: "" + + - name: "avg_response_time" + type: "number" + description: "" + + - name: "avg_sla_breach_time" + type: "number" + description: "" + + - name: "avg_total_reply_time" + type: "number" + description: "" + + - name: "metric_description" + type: "string" + description: "" + + - name: "metric_id" + type: "string" + description: "" + + - name: "new_segments_count" + type: "number" + description: "" + + - name: "num_active_segments_full" + type: "number" + description: "" + + - name: "num_archived_segments" + type: "number" + description: "" + + - name: "num_archived_segments_with_reply" + type: "number" + description: "" + + - name: "num_closed_segments" + type: "number" + description: "" + + - name: "num_csat_survey_response" + type: "number" + description: "" + + - name: "num_messages_received" + type: "number" + description: "" + + - name: "num_messages_sent" + type: "number" + description: "" + + - name: "num_open_segments_end" + type: "number" + description: "" + + - name: "num_open_segments_start" + type: "number" + description: "" + + - name: "num_sla_breach" + type: "number" + description: "" + + - name: "num_workload_segments" + type: "number" + description: "" + + - name: "pct_csat_survey_satisfaction" + type: "number" + description: "" + + - name: "pct_tagged_conversations" + type: "number" + description: "" + + - name: "report_id" + type: "string" + description: "" + primary-key: true + diff --git a/_integration-schemas/frontapp/v1/tags_table.md b/_integration-schemas/frontapp/v1/tags_table.md index 2136806f6..bb5c12d3d 100644 --- a/_integration-schemas/frontapp/v1/tags_table.md +++ b/_integration-schemas/frontapp/v1/tags_table.md @@ -20,56 +20,102 @@ api-method: doc-link: "https://dev.frontapp.com/#analytics" attributes: - - name: "tag_v" + - name: "analytics_date" type: "string" - primary-key: true - description: "The tag ID." + description: "" + replication-key: true - name: "analytics_range" type: "string" - primary-key: true - description: "The range the analytics pertain to." - - - name: "analytics_date" - type: "date" - primary-key: true + description: "" replication-key: true - description: "The date the analytics pertain to." - - name: "avg_message_conversations_p" + - name: "avg_first_response_time" + type: "number" + description: "" + + - name: "avg_handle_time" + type: "number" + description: "" + + - name: "avg_response_time" + type: "number" + description: "" + + - name: "avg_sla_breach_time" + type: "number" + description: "" + + - name: "avg_total_reply_time" + type: "number" + description: "" + + - name: "metric_description" + type: "string" + description: "" + + - name: "metric_id" + type: "string" + description: "" + + - name: "new_segments_count" type: "number" description: "" - - name: "avg_message_conversations_v" + + - name: "num_active_segments_full" + type: "number" + description: "" + + - name: "num_archived_segments" type: "number" description: "" - - name: "conversations_archived_p" - type: "integer" + + - name: "num_archived_segments_with_reply" + type: "number" description: "" - - name: "conversations_archived_v" - type: "integer" + + - name: "num_closed_segments" + type: "number" description: "" - - name: "conversations_open_p" - type: "integer" + + - name: "num_csat_survey_response" + type: "number" + description: "" + + - name: "num_messages_received" + type: "number" + description: "" + + - name: "num_messages_sent" + type: "number" description: "" - - name: "conversations_open_v" - type: "integer" + + - name: "num_open_segments_end" + type: "number" description: "" - - name: "conversations_total_p" - type: "integer" + + - name: "num_open_segments_start" + type: "number" description: "" - - name: "conversations_total_v" - type: "integer" + + - name: "num_sla_breach" + type: "number" description: "" - - name: "num_messages_p" - type: "integer" + + - name: "num_workload_segments" + type: "number" description: "" - - name: "num_messages_v" - type: "integer" + + - name: "pct_csat_survey_satisfaction" + type: "number" description: "" - - name: "tag_id" - type: "integer" + + - name: "pct_tagged_conversations" + type: "number" description: "" - - name: "tag_url" + + - name: "report_id" type: "string" description: "" + primary-key: true --- diff --git a/_integration-schemas/frontapp/v1/team_table.md b/_integration-schemas/frontapp/v1/team_table.md deleted file mode 100644 index bfbc57c2b..000000000 --- a/_integration-schemas/frontapp/v1/team_table.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -tap: "frontapp" -version: "1" - -name: "team_table" -doc-link: "https://dev.frontapp.com/#analytics" -singer-schema: "https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/team_table.json" -description: | - The `{{ table.name }}` table contains a list of team member statistics since the last completed replication job through the most recent iteration of the defined [**Incremental Range**](#add-stitch-data-source) (day or hour). - - This table will include team members from all teams in your {{ integration.display_name }} account. - - **Note**: During the historical replication job, all increments since the **Start Date** will be replicated. This will result in the first record for this table being an aggregated record across all team members. - -replication-method: "Key-based Incremental" - -api-method: - name: "Get analytics" - doc-link: "https://dev.frontapp.com/#get-analytics" - -attributes: - - name: "analytics_range" - type: "string" - primary-key: true - description: "The range the analytics pertain to." - - - name: "teammate_v" - type: "string" - primary-key: true - description: "The team member's ID." - # foreign-key-id: "teammate-id" - - - name: "analytics_date" - type: "date" - primary-key: true - replication-key: true - description: "The date the analytics pertain to." - - - name: "avg_first_reaction_time_p" - type: "number" - description: "The team member's average first reaction time for the previous period." - - - name: "avg_first_reaction_time_v" - type: "number" - description: "The team member's average first reaction time for the current period." - - - name: "avg_message_conversations_p" - type: "number" - description: "The team member's average number of message conversations for the previous period." - - - name: "avg_message_conversations_v" - type: "number" - description: "The team member's average number of message conversations for the current period." - - - name: "avg_reaction_time_p" - type: "number" - description: "The team member's average reaction time for the previous period." - - - name: "avg_reaction_time_v" - type: "number" - description: "The team member's average reaction time for the current period." - - - name: "num_composed_p" - type: "integer" - description: "The team member's number of composed messages for the previous period." - - - name: "num_composed_v" - type: "integer" - description: "The team member's number of composed messages for the current period." - - - name: "num_conversations_p" - type: "integer" - description: "The team member's number of conversations for the previous period." - - - name: "num_conversations_v" - type: "integer" - description: "The team member's number of conversations for the current period." - - - name: "num_messages_p" - type: "integer" - description: "The team member's number of messages for the previous period." - - - name: "num_messages_v" - type: "integer" - description: "The team member's number of messages for the current period." - - - name: "num_replied_p" - type: "integer" - description: "The team member's number of replies for the previous period." - - - name: "num_replied_v" - type: "integer" - description: "The team member's number of replies for the current period." - - - name: "num_sent_p" - type: "integer" - description: "The team member's number of sent messages for the previous period." - - - name: "num_sent_v" - type: "integer" - description: "The team member's number of sent messages for the current period." - - - name: "teammate_id" - type: "integer" - description: "" - - - name: "teammate_p" - type: "string" - description: "" - - - name: "teammate_url" - type: "string" - description: "The team member's URL in {{ integration.display_name }}." ---- \ No newline at end of file diff --git a/_integration-schemas/frontapp/v1/teammates_table.md b/_integration-schemas/frontapp/v1/teammates_table.md new file mode 100644 index 000000000..7e8f91724 --- /dev/null +++ b/_integration-schemas/frontapp/v1/teammates_table.md @@ -0,0 +1,113 @@ +--- +tap: "frontapp" +version: "V1" +key: "" + +name: "teammates_table" +doc-link: +singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/teammates_table.json +description: "" + +replication-method: "Key-based Incremental" + +table-key-properties: "report_id" +valid-replication-keys: "analytics_date", "analytics_range" + +attributes: + - name: "analytics_date" + type: "string" + description: "" + replication-key: true + - name: "analytics_range" + type: "string" + description: "" + replication-key: true + - name: "avg_first_response_time" + type: "number" + description: "" + + - name: "avg_handle_time" + type: "number" + description: "" + + - name: "avg_response_time" + type: "number" + description: "" + + - name: "avg_sla_breach_time" + type: "number" + description: "" + + - name: "avg_total_reply_time" + type: "number" + description: "" + + - name: "metric_description" + type: "string" + description: "" + + - name: "metric_id" + type: "string" + description: "" + + - name: "new_segments_count" + type: "number" + description: "" + + - name: "num_active_segments_full" + type: "number" + description: "" + + - name: "num_archived_segments" + type: "number" + description: "" + + - name: "num_archived_segments_with_reply" + type: "number" + description: "" + + - name: "num_closed_segments" + type: "number" + description: "" + + - name: "num_csat_survey_response" + type: "number" + description: "" + + - name: "num_messages_received" + type: "number" + description: "" + + - name: "num_messages_sent" + type: "number" + description: "" + + - name: "num_open_segments_end" + type: "number" + description: "" + + - name: "num_open_segments_start" + type: "number" + description: "" + + - name: "num_sla_breach" + type: "number" + description: "" + + - name: "num_workload_segments" + type: "number" + description: "" + + - name: "pct_csat_survey_satisfaction" + type: "number" + description: "" + + - name: "pct_tagged_conversations" + type: "number" + description: "" + + - name: "report_id" + type: "string" + description: "" + primary-key: true + diff --git a/_integration-schemas/frontapp/v1/teams_table.md b/_integration-schemas/frontapp/v1/teams_table.md new file mode 100644 index 000000000..028f3ab8f --- /dev/null +++ b/_integration-schemas/frontapp/v1/teams_table.md @@ -0,0 +1,113 @@ +--- +tap: "frontapp" +version: "V1" +key: "" + +name: "teams_table" +doc-link: +singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/teams_table.json +description: "" + +replication-method: "Key-based Incremental" + +table-key-properties: "report_id" +valid-replication-keys: "analytics_date", "analytics_range" + +attributes: + - name: "analytics_date" + type: "string" + description: "" + replication-key: true + - name: "analytics_range" + type: "string" + description: "" + replication-key: true + - name: "avg_first_response_time" + type: "number" + description: "" + + - name: "avg_handle_time" + type: "number" + description: "" + + - name: "avg_response_time" + type: "number" + description: "" + + - name: "avg_sla_breach_time" + type: "number" + description: "" + + - name: "avg_total_reply_time" + type: "number" + description: "" + + - name: "metric_description" + type: "string" + description: "" + + - name: "metric_id" + type: "string" + description: "" + + - name: "new_segments_count" + type: "number" + description: "" + + - name: "num_active_segments_full" + type: "number" + description: "" + + - name: "num_archived_segments" + type: "number" + description: "" + + - name: "num_archived_segments_with_reply" + type: "number" + description: "" + + - name: "num_closed_segments" + type: "number" + description: "" + + - name: "num_csat_survey_response" + type: "number" + description: "" + + - name: "num_messages_received" + type: "number" + description: "" + + - name: "num_messages_sent" + type: "number" + description: "" + + - name: "num_open_segments_end" + type: "number" + description: "" + + - name: "num_open_segments_start" + type: "number" + description: "" + + - name: "num_sla_breach" + type: "number" + description: "" + + - name: "num_workload_segments" + type: "number" + description: "" + + - name: "pct_csat_survey_satisfaction" + type: "number" + description: "" + + - name: "pct_tagged_conversations" + type: "number" + description: "" + + - name: "report_id" + type: "string" + description: "" + primary-key: true +