Lister les règles de diffusion

Récupère, pour chacun de vos diffuseurs, les règles de diffusion configurées.

Retourne la liste de vos partenaires diffuseurs, chacun accompagné des règles de diffusion que vous avez configurées pour lui. Un diffuseur sans règle reçoit toutes vos missions (voir Comprendre les règles de diffusion).

Paramètres de requête

Paramètre	Obligatoire	Description
field	non	Champ sur lequel évaluer la diffusion : type, publisherOrganizationId, publisherOrganization.clientId ou publisherOrganization.parentOrganizations. À fournir conjointement avec value.
value	non	Valeur recherchée sur le champ field. À fournir conjointement avec field.

field et value vont par paire : fournir l'un sans l'autre renvoie une erreur 400. Lorsqu'ils sont présents, chaque diffuseur est annoté d'un booléen diffuse indiquant s'il diffuserait une mission portant cette valeur sur ce champ — false si une de ses règles d'exclusion (is_not, does_not_contain, does_not_exist) sur ce champ exclut la valeur, true sinon. Le détail du calcul est décrit dans Comprendre les règles de diffusion.

Exemple — savoir quels diffuseurs excluent le réseau « Marine nationale » :

GET /v0/diffusion-rule?field=publisherOrganization.parentOrganizations&value=Marine nationale

Lister les règles de diffusion

get

https://api.api-engagement.beta.gouv.frhttps://api.bac-a-sable.api-engagement.beta.gouv.frhttp://localhost:3002

/v0/diffusion-rule

Retourne, pour chacun de vos partenaires diffuseurs, les règles de diffusion que vous avez configurées en tant qu'annonceur. Ces règles déterminent quelles missions sont diffusées vers chaque diffuseur.

Les paramètres field et value doivent être fournis ensemble (les deux ou aucun) : lorsqu'ils sont présents, chaque diffuseur est en plus annoté d'un booléen diffuse indiquant s'il diffuserait la valeur recherchée pour ce champ. Fournir un seul des deux renvoie une erreur 400.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Clé API fournie par l'équipe API Engagement

Query parameters

fieldstringOptional

Champ sur lequel évaluer la diffusion. À fournir conjointement avec value. Valeurs possibles : type, publisherOrganizationId, publisherOrganization.clientId, publisherOrganization.parentOrganizations.

Example: publisherOrganization.parentOrganizations

valuestringOptional

Valeur recherchée sur le champ field. À fournir conjointement avec field.

Example: Marine nationale

Responses

200

Liste des diffuseurs avec leurs règles de diffusion

application/json

okbooleanOptionalExample: true

totalintegerOptional

Nombre de diffuseurs retournés

Example: 3

400

Paramètres invalides

application/json

401

Clé API manquante ou invalide

application/json

get/v0/diffusion-rule

HTTPcURLJavaScriptPython

GET /v0/diffusion-rule HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: YOUR_API_KEY
Accept: */*

{
  "ok": true,
  "total": 3,
  "data": [
    {
      "id": "5f5931496c7ea514150a818f",
      "name": "JeVeuxAider.gouv.fr",
      "logo": "https://example.com",
      "rules": [
        {
          "id": "9b1c2d3e-4f56-7890-abcd-ef0123456789",
          "field": "type",
          "fieldType": "string",
          "operator": "is_not",
          "value": "benevolat"
        }
      ],
      "diffuse": false
    }
  ]
}