Chapter 3. Defining methods and metrics

Procedure

1. Navigate to [Your_product_name] > Integration > Methods & Metrics or [Your_backend_name] > Methods & Metrics.
2. Click New method.

3. In the Friendly name field, enter a short description of the method. This name is displayed in different sections of the 3scale Admin Portal. The friendly name must be unique for the product.

   Important

   Be careful with changing the system name of the methods or deleting them. These changes can break your already deployed 3scale integration if there are mapping rules pointing to the previous system name of the method.

4. In the System name field, enter the name of the method in your API to use to report the usage through the 3scale Service Management API. The system name must conform to these rules:

   • Unique in the product or backend
   • Contain only alphanumeric characters, underscore _, hyphen - or forward slash /
   • No spaces

   Otherwise, you are free to decide what the system name looks like. It can be the same as the endpoint (/status), or, for example, it can include the method and the path (GET_/status).

5. Optional: In the Description field, enter a more detailed description of the method.
6. Click Create Method.

Procedure

1. Navigate to [Your_product_name] > Integration > Methods & Metrics or [Your_backend_name] > Methods & Metrics.
2. Click New metric.

3. In the Friendly name field, enter a short description of the metric. This name is displayed in different sections of the 3scale Admin Portal. The friendly name must be unique for the product.

   Important

   Be careful with changing the system name of the metrics or deleting them. These changes can break your already deployed 3scale integration if there are mapping rules pointing to the previous system name of the metric.

4. In the System name field, enter the name of the metric in your API to use to report the usage through the 3scale Service Management API. The system name must conform to these rules:

   • Unique in the product or backend
   • Contain only alphanumeric characters, underscore _, hyphen - or forward slash /
   • No spaces

   Otherwise, you are free to decide what the system name looks like.

5. In the Unit field, enter the unit.

   • Use a singular noun, for example, hit. The singular will become plural in the analytics charts.
6. Optional: In the Description field, enter a more detailed description of the metric.
7. Click Create Metric.

Procedure

1. Navigate to [Your_product_name] > Integration > Mapping Rules.
2. Click Add Mapping Rule.
3. The Verb field is pre-populated with the HTTP method, GET, however you can select other options from the dropdown list.
4. In the Pattern field, add a valid URL that starts with an forward slash /. The URL can be from a wildcard you specified inside curly brackets {}.
5. In the Metric or Method to increment field, select from one of your previously created methods or metrics.
6. The Increment by field is pre-populated with 1, however, change this to suit your own needs.
7. Click the Create Mapping Rule button.