Leitura de entidades do Intercom
Pré-requisitos
-
Um objeto do Intercom do qual você deseja ler. Consulte a tabela de entidades compatíveis abaixo para verificar as entidades disponíveis.
Entidades compatíveis
| Entidade | API_Version | Pode ser filtrada | Oferece suporte a limite | Oferece suporte a Ordenar por | Oferece suporte a Selecionar * | Oferece suporte a particionamento |
|---|---|---|---|---|---|---|
| Admins | v2.5 | Não | Não | Não | Sim | Não |
| Empresas | v2.5 | Não | Sim | Não | Sim | Não |
| Conversas | v2.5 | Sim | Sim | Sim | Sim | Sim |
| Atributos de dados | v2.5 | Não | Não | Não | Sim | Não |
| Contatos | v2.5 | Sim | Sim | Sim | Sim | Sim |
| Segmentos | v2.5 | Não | Não | Não | Sim | Não |
| Tags | v2.5 | Não | Não | Não | Sim | Não |
| Equipes | v2.5 | Não | Não | Não | Sim | Não |
Exemplo
Intercom_read = glueContext.create_dynamic_frame.from_options( connection_type="Intercom", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "company", "API_VERSION": "V2.5" } )
Detalhes das entidades e dos campos do Intercom
| Entidade | Campo | Tipo de dado | Operadores com suporte |
|---|---|---|---|
| Admins | type | String | NA |
| Admins | id | String | NA |
| Admins | avatar | Struct | NA |
| Admins | nome | String | NA |
| Admins | String | NA | |
| Admins | away_mode_enabled | Booleano | NA |
| Admins | away_mode_reassign | Booleano | NA |
| Admins | has_inbox_seat | Booleano | NA |
| Admins | teams_ids | Lista | NA |
| Admins | job_title | String | NA |
| Empresas | type | String | NA |
| Empresas | id | String | NA |
| Empresas | app_id | String | NA |
| Empresas | created_at | DateTime | NA |
| Empresas | remote_created_at | DateTime | NA |
| Empresas | updated_at | DateTime | NA |
| Empresas | last_request_at | DateTime | NA |
| Empresas | planejar | Struct | NA |
| Empresas | company_id | String | NA |
| Empresas | nome | String | NA |
| Empresas | custom_attributes | Struct | NA |
| Empresas | session_count | Inteiro | NA |
| Empresas | monthly_spend | Inteiro | NA |
| Empresas | user_count | Inteiro | NA |
| Empresas | setor | String | NA |
| Empresas | size | Inteiro | NA |
| Empresas | site | String | NA |
| Empresas | tags | Struct | NA |
| Empresas | segmentos | Struct | NA |
| Contatos | id | String | EQUAL_TO.NOT_EQUAL_TO |
| Contatos | type | String | NA |
| Contatos | workspace_id | String | NA |
| Contatos | external_id | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | perfil | String | EQUAL_TO.NOT_EQUAL_TO |
| Contatos | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO | |
| Contatos | phone | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | nome | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | avatar | String | NA |
| Contatos | owner_id | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | social_profiles | Struct | NA |
| Contatos | has_hard_bounced | Booleano | EQUAL_TO |
| Contatos | marked_email_as_spam | Booleano | EQUAL_TO |
| Contatos | unsubscribed_from_emails | Booleano | EQUAL_TO |
| Contatos | created_at | DateTime | EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | updated_at | DateTime | EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | signed_up_at | DateTime | EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | last_seen_at | DateTime | EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | last_replied_at | DateTime | EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | last_contacted_at | DateTime | EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | last_email_opened_at | DateTime | EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | last_email_clicked_at | DateTime | EQUAL_TO, GREATER_THAN, LESS_THAN |
| Contatos | language_override | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | navegador | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | browser_version | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | browser_language | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | os | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | local | Struct | NA |
| Contatos | location_country | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | location_region | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | location_city | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | android_app_name | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | android_app_version | String | NA |
| Contatos | android_device | String | NA |
| Contatos | android_os_version | String | NA |
| Contatos | android_sdk_version | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | android_last_seen_at | Data | NA |
| Contatos | ios_app_name | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | ios_app_version | String | NA |
| Contatos | ios_device | String | NA |
| Contatos | ios_os_version | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | ios_sdk_version | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Contatos | ios_last_seen_at | DateTime | NA |
| Contatos | custom_attributes | Struct | NA |
| Contatos | tags | Struct | NA |
| Contatos | notes | Struct | NA |
| Contatos | empresas | Struct | NA |
| Contatos | unsubscribed_from_sms | Booleano | NA |
| Contatos | sms_consent | Booleano | NA |
| Contatos | opted_out_subscription_types | Struct | NA |
| Contatos | indicador | String | NA |
| Contatos | utm_campaign | String | NA |
| Contatos | utm_content | String | NA |
| Contatos | utm_medium | String | NA |
| Contatos | utm_source | String | NA |
| Contatos | utm_term | String | NA |
| Conversas | type | String | NA |
| Conversas | id | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | created_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | updated_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | origem | Struct | NA |
| Conversas | source_id | String | EQUAL_TO, NOT_EQUAL_TO |
| Conversas | source_type | String | EQUAL_TO, NOT_EQUAL_TO, |
| Conversas | source_delivered_as | String | EQUAL_TO, NOT_EQUAL_TO, |
| Conversas | source_subject | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | source_body | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | source_author_id | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | source_author_type | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | source_author_name | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | source_author_email | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | source_url | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | contacts | Struct | NA |
| Conversas | colegas de equipe | Struct | NA |
| Conversas | título | String | NA |
| Conversas | admin_assignee_id | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | team_assignee_id | Inteiro | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | custom_attributes | Struct | NA |
| Conversas | aberto | Booleano | EQUAL_TO |
| Conversas | estado | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | leitura | Booleano | EQUAL_TO |
| Conversas | waiting_since | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | snoozed_until | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | tags | Struct | NA |
| Conversas | first_contact_reply | Struct | NA |
| Conversas | priority | String | EQUAL_TO, NOT_EQUAL_TO |
| Conversas | tópicos | Struct | NA |
| Conversas | sla_applied | Struct | NA |
| Conversas | conversation_rating | Struct | NA |
| Conversas | conversation_rating_requested_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | conversation_rating_replied_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | conversation_rating_score | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | conversation_rating_remark | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | conversation_rating_contact_id | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | conversation_rating_admin_id | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | estatísticas | Struct | NA |
| Conversas | statistics_time_to_assignment | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_time_to_admin_reply | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_time_to_first_close | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_time_to_last_close | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_median_time_to_reply | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_first_contact_reply_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_first_assignment_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_first_admin_reply_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_first_close_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_last_assignment_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_last_assignment_admin_reply_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_last_contact_reply_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_last_admin_reply_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_last_close_at | DateTime | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_last_closed_by_id | String | CONTAINS, EQUAL_TO, NOT_EQUAL_TO |
| Conversas | statistics_count_reopens | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_count_assignments | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | statistics_count_conversation_parts | Inteiro | EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN |
| Conversas | conversation_parts | Lista | NA |
| Atributos de dados | id | Inteiro | NA |
| Atributos de dados | type | String | NA |
| Atributos de dados | modelo | String | NA |
| Atributos de dados | nome | String | NA |
| Atributos de dados | full_name | String | NA |
| Atributos de dados | rótulo | String | NA |
| Atributos de dados | description | String | NA |
| Atributos de dados | data_type | String | NA |
| Atributos de dados | options | Lista | NA |
| Atributos de dados | api_writable | Booleano | NA |
| Atributos de dados | ui_writable | Booleano | NA |
| Atributos de dados | personalizado | Booleano | NA |
| Atributos de dados | archived | Booleano | NA |
| Atributos de dados | created_at | Booleano | NA |
| Atributos de dados | updated_at | DateTime | NA |
| Atributos de dados | admin_id | String | NA |
| Segmentos | type | String | NA |
| Segmentos | id | String | NA |
| Segmentos | nome | String | NA |
| Segmentos | created_at | DateTime | NA |
| Segmentos | updated_at | DateTime | NA |
| Segmentos | person_type | String | NA |
| Segmentos | contagem | Inteiro | NA |
| Tags | type | String | NA |
| Tags | id | String | NA |
| Tags | nome | String | NA |
| Equipes | type | String | NA |
| Equipes | id | String | NA |
| Equipes | nome | String | NA |
| Equipes | admin_ids | Lista | NA |
Particionamento de consultas
Podem ser fornecidas as opções adicionais do Spark PARTITION_FIELD, LOWER_BOUND, UPPER_BOUND e NUM_PARTITIONS se você quiser utilizar a simultaneidade no Spark. Com esses parâmetros, a consulta original seria dividida em NUM_PARTITIONS subconsultas, que poderiam ser executadas pelas tarefas do Spark simultaneamente.
-
PARTITION_FIELD: o nome do campo a ser usado para particionar a consulta. -
LOWER_BOUND: um valor limite inferior inclusivo do campo de partição escolhido.Na data, aceitamos o formato de data do Spark usado em consultas SQL do Spark. Exemplo de valores válidos:
"2024-02-06". -
UPPER_BOUND: um valor limite superior exclusivo do campo de partição escolhido. -
NUM_PARTITIONS: número de partições.
Os detalhes do suporte do campo de particionamento relativo às entidades são capturados na tabela a seguir.
| Entity Name | Campo de particionamento | Tipo de dado |
|---|---|---|
| Contatos | created_at, updated_at,last_seen_at | DateTime |
| Conversas | id | Inteiro |
| Conversas | created_at, updated_at | DateTime |
Exemplo
Intercom_read = glueContext.create_dynamic_frame.from_options( connection_type="Intercom", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "conversation", "API_VERSION": "V2.5", "PARTITION_FIELD": "created_at" "LOWER_BOUND": "2022-07-13T07:55:27.065Z" "UPPER_BOUND": "2022-08-12T07:55:27.065Z" "NUM_PARTITIONS": "2" } )