Skip to main content
Feedback

Analysis on EAV for inclusion in ASR Request

This page outlines which EAVs and Standard fields should be included in the ASR Service.

Objective

It is suggested that EAV and standard fields should also be included in the ASR request. R4 generally supports the following six models for including EAVs and standard fields:

  • Application

  • Member

  • Plan

  • Package

  • Service Key

  • Package Key

Generally, it is not a good idea to expose all standard fields for the models above, as some standard fields are secured and should not be exposed. If a large number of standard fields are exposed, it also impacts performance, as the size of the blob containing these fields increases, which is directly proportional to the time taken to retrieve this blob from the database or memcache.

This page is designed to discuss what EAVs and Standard fields should be part of ASR Service.

Supported Models

This section describes all standard fields for the supported model and whether those fields should be included.

Plans

Field NameAvailable In Proxy CoreProxy-Core Object NameProxy-Core Field NameSupport for ASR Request
id✅PlanConfigurationId✅
area_id❌--❌
package_id✅PlanConfiguration.PackageConfigurationId✅
name✅PlanConfigurationplanName✅
description❌--❌
notes❌--❌
rate_limit_ceiling✅PlanConfigurationrateLimitCeiling-
rate_limit_exempt✅PlanConfigurationrateLimitExempt-
rate_limit_order_overide_allowed❌--❌
rate_limit_key_override_allowed✅PlanConfigurationrateLimitKeyOverrideAllowed-
rate_limit_period✅PlanConfigurationrateLimitPeriod-
qps_limit_ceiling✅PlanConfigurationqpsLimitCeiling-
qps_limit_exempt✅PlanConfigurationqpsLimitExempt-
qps_limit_order_override_allowed❌--❌
qps_limit_key_override_allowed✅PlanConfigurationqpsLimitKeyOverrideAllowed-
order_max❌--❌
order_moderation_threshold❌--❌
response_filter_override_allowed❌--❌
email_template_set_id✅PlanConfigurationemailTemplateSetId-
eav✅PlanConfigurationeav✅
created❌--❌
updated❌--❌
is_public❌--❌
is_moderated❌--❌
status❌--❌
uuid❌--❌

Packages

Supported Field Name By ConnectorAvailable In Proxy CoreProxy-Core Object NameProxy-Core Field NameSupport for ASR Request
id✅PackageConfigurationid✅
area_id❌--❌
name✅PackageConfigurationname✅
description❌--❌
notify_developer_period✅PackageConfigurationnotifyDeveloperPeriod-
notify_developer_near_quota✅PackageConfigurationnotifyDeveloperNearQuota-
notify_developer_over_quota✅PackageConfigurationnotifyDeveloperOverQuota-
notify_developer_over_throttle✅PackageConfigurationnotifyDeveloperOverThrottle-
notify_admin_period✅PackageConfigurationnotifyAdminPeriod-
notify_admin_near_quota✅PackageConfigurationnotifyAdminNearQuota-
notify_admin_over_quota✅PackageConfigurationnotifyAdminOverQuota-
notify_admin_over_throttle✅PackageConfigurationnotifyAdminOverThrottle-
notify_admin_emails✅PackageConfigurationnotifyAdminEmails-
near_quota_threshold✅PackageConfigurationnearQuotaThreshold-
eav✅PackageConfigurationeav✅
created❌--❌
updated❌--❌
key_adapter❌--❌
key_length❌--❌
shared_secret_length❌--❌
status❌--❌
uuid❌--❌
org_id❌--❌

Applications

Supported Field Name By ConnectorAvailable In Proxy CoreProxy-Core Object NameProxy-Core Field NameSupport for ASR Request
id✅DeveloperConfigurationappId✅
created❌--❌
updated❌--❌
handle❌--❌
name❌--✅
summ❌--❌
type❌--❌
commercial❌--❌
ads❌--❌
ads_system❌--❌
usage_model❌--❌
tags❌--❌
notes❌--❌
how_did_you_hear❌--❌
preferred_protocol❌--❌
preferred_output❌--❌
prefs❌--❌
eav❌--✅
external_id❌--❌
uri❌--❌
status❌--❌
area_id❌--❌
is_packaged❌--❌
oauth_redirect_uri❌--❌
uuid❌--❌

Keys

Supported Field Name By ConnectorAvailable In Proxy CoreProxy-Core Object NameProxy-Core Field NameSupport for ASR Request
id✅DeveloperConfigurationid-
created✅DeveloperConfigurationcreated-
updated✅DeveloperConfigurationupdated-
area_id✅DeveloperConfigurationareaId✅
spkey✅DeveloperConfigurationspkey✅
mapi✅DeveloperConfigurationmapi✅
handle✅DeveloperConfigurationhandle✅
status✅DeveloperConfigurationstatus-
rate_limit_ceiling✅DeveloperConfigurationrateLimitCeiling✅
qps_limit_ceiling✅DeveloperConfigurationqpsLimitCeiling✅
rate_limit_exempt✅DeveloperConfigurationrateLimitExempt-
qps_limit_exempt✅DeveloperConfigurationqpsLimitExempt-
request_notification_blocked✅DeveloperConfigurationrequestNotificationBlocked-
required_referer✅DeveloperConfigurationrequiredReferer-
passwd✅DeveloperConfigurationpasswd❌
secret✅DeveloperConfigurationsecret❌
permitted_request_methods✅DeveloperConfigurationpermittedRequestMethods-
permitted_api_methods✅DeveloperConfigurationpermittedApitMethods-
permitted_api_paths✅DeveloperConfigurationpermittedApiPaths-
prefs✅DeveloperConfigurationprefs-
eav✅DeveloperConfigurationeav✅
app_id✅DeveloperConfigurationappId✅
developer_class_id✅DeveloperConfigurationdeveloperClassId-

Package Keys

Supported Field Name By ConnectorField Available In Proxy CoreProxy-Core Object NameProxy-Core Field NameSupport for ASR Request
id✅DeveloperConfiguration.PackageKeySettingsid-
area_id✅DeveloperConfigurationareaId✅
app_id✅DeveloperConfigurationappId✅
package_id✅DeveloperConfiguration.PackageKeySettingspackageId✅
plan_id✅DeveloperConfiguration.PackageKeySettingsplanId✅
apikey✅DeveloperConfigurationmapi✅
secret❌--❌
rate_limit_ceiling✅DeveloperConfiguration.PackageKeySettingspackageRateLimitCeiling✅
rate_limit_exempt✅DeveloperConfiguration.PackageKeySettingspackageRateLimitExempt-
qps_limit_ceiling✅DeveloperConfiguration.PackageKeySettingspackageQpsLimitCeiling✅
qps_limit_exempt✅DeveloperConfiguration.PackageKeySettingspackageQpsLimitExempt-
status✅DeveloperConfiguration.PackageKeySettingsstatus-
created❌--❌
updated❌--❌
handle❌--❌
eav✅DeveloperConfiguration.PackageKeySettingseav✅
uuid❌--❌

Members

Supported Field Name By ConnectorAvailable In Proxy CoreProxy-Core Object NameProxy-Core Field NameSupport for ASR Request
id❌--❌
created❌--❌
updated❌--❌
handle✅DeveloperConfigurationhandle✅
passwd❌--❌
email✅DeveloperConfigurationemail✅
moniker✅DeveloperConfigurationmoniker✅
uri❌--❌
status✅DeveloperConfigurationmember_status✅
blog❌--❌
im❌--❌
imsvc❌--❌
phone❌--❌
company❌--❌
address1❌--❌
address2❌--❌
city_or_town❌--❌
state_province_abbr❌--❌
zip_code❌--❌
country_code❌--❌
prefs❌--❌
first_name❌--❌
last_name❌--❌
registration_area_id❌--❌
registration_ipaddr❌--❌
uuid❌--❌
eav❌--✅
On this Page