apyhub-logo
FusionPlatformAPI CatalogPricingBlog
Log in

Extract User Agent API

Data Extraction#extract#user-agent
20 atoms
Base tier

About

This Utility API lets you dynamically find the user agent information based on the user agent string passed.
Detecting user agents in applications is vital because it enables the optimization of user experience based on the device being used. The user agent finder dynamically identifies the user agent string passed, which can be a challenging task due to the numerous combinations of user agents, especially when done dynamically. By leveraging the user agent information, applications can tailor their content to provide the best possible experience and performance for users. This means that the application can adjust its layout, design, and functionality to suit the specific device accessing it, resulting in a more user-friendly and engaging experience. In short, detecting user agents is crucial for applications to deliver personalized and optimized experiences that increase user satisfaction and loyalty.

API Playground

API Documentation

user agent
POST
https://api.apyhub.com/extract/user-agent

Request example

1
curl --location --request POST 'https://api.apyhub.com/extract/user-agent \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data-raw '{
5
  "user_agent" : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"
6
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
user_agentstringYesthe string from which you want to pull out the user agent information.
Sample Response
A successful request returns the data object with below mentioned attributes:
1
{
2
    "data": {
3
        "browser": {
4
            "name": "Chrome",
5
            "type": "",
6
            "version": "105.0",
7
            "major_version": "105",
8
            "minor_version": "0",
9
            "icon": "https://assets.apyhub.com/static/browser/chrome.png"
10
        },
11
        "platform": {
12
            "name": "macOS",
13
            "version": "",
14
            "short": "mac",
15
            "icon": "https://assets.apyhub.com/static/os/mac.png"
16
        },
17
        "device": {
18
            "name": "",
19
            "type": "Desktop",
20
            "code_name": "",
21
            "brand": "",
22
            "icon": "https://assets.apyhub.com/static/devices/default.png"
23
        },
24
        "engine": {
25
            "name": "",
26
            "version": ""
27
        }
28
    }
29
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input.
500If any unexpected error occurs while processing the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.