Métricas de parceiros financeiros - Juridiq Software

Métricas de parceiros financeiros

curl --request GET \
  --url https://api.juridiq.com.br/metrics/partners \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/metrics/partners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/metrics/partners",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/metrics/partners"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/metrics/partners")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "totalPartners": 123,
  "linkedLawsuitsCount": 123,
  "commissionPending": 123,
  "commissionPaidByMonth": [
    {
      "month": "<string>",
      "label": "<string>",
      "amount": 123
    }
  ],
  "lawsuitsByPartner": [
    {
      "partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partnerName": "<string>",
      "lawsuitsCount": 123
    }
  ]
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

GET

/

metrics

/

partners

Métricas de parceiros financeiros

curl --request GET \
  --url https://api.juridiq.com.br/metrics/partners \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/metrics/partners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/metrics/partners",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/metrics/partners"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/metrics/partners")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "totalPartners": 123,
  "linkedLawsuitsCount": 123,
  "commissionPending": 123,
  "commissionPaidByMonth": [
    {
      "month": "<string>",
      "label": "<string>",
      "amount": 123
    }
  ],
  "lawsuitsByPartner": [
    {
      "partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "partnerName": "<string>",
      "lawsuitsCount": 123
    }
  ]
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Query Parameters

startDate

string

required

Início do período (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$

endDate

string

required

Fim do período (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$

periodType

enum<string>

Available options:

day,

week,

month,

custom

partnerId

string<uuid>

Filtra métricas deste parceiro

Response

Default Response

totalPartners

number

required

Parceiros cadastrados (snapshot)

linkedLawsuitsCount

number

required

Processos com parceiro vinculado (snapshot)

commissionPending

number

required

Comissão a pagar (não paga)

commissionPaidByMonth

object[]

required

Últimos 6 meses até endDate

Show child attributes

lawsuitsByPartner

object[]

required

Ranking atual de processos vinculados

Show child attributes